Skip to main content
PATCH
/
v0
/
subscriptions
/
{subscriptionIdOrNumber}
/
update
Update Subscription
curl --request PATCH \
  --url https://api.fungies.io/v0/subscriptions/{subscriptionIdOrNumber}/update \
  --header 'Content-Type: application/json' \
  --header 'x-fngs-public-key: <api-key>' \
  --header 'x-fngs-secret-key: <api-key>' \
  --data '
{
  "items": [
    {
      "name": "<string>",
      "unitPrice": 123,
      "quantity": 1,
      "offerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "price": 8.988465674311579e+307,
      "value": 8.988465674311579e+307
    }
  ],
  "prorationBehavior": "none"
}
'
{
  "status": "<string>",
  "data": {
    "success": true
  }
}

Authorizations

​
x-fngs-public-key
string
header
required
​
x-fngs-secret-key
string
header
required

Path Parameters

​
subscriptionIdOrNumber
string
required

Subscription ID or order number

Pattern: ^#?([0-9A-Za-z]{12,32}|[0-9]+)(-[0-9]+)?$

Body

application/json

PATCH /v0/subscriptions/:subscriptionIdOrNumber/update Request body

​
items
object[]
required
Required array length: 1 element
​
prorationBehavior
enum<string>
default:none
Available options:
none,
create_prorations,
always_invoice

Response

PATCH /v0/subscriptions/:subscriptionIdOrNumber/update Positive response

​
status
string
required
Allowed value: "success"
​
data
object
required