Skip to main content
POST
Update Subscription

Authorizations

Authorization
string
header
required

Bearer API Key authentication. Format: Authorization: Bearer {your_api_key}

Headers

Request-Id
string
default:008e3967-a1b5-48bb-be14-d5bff5092e61
required

The unique identifier of the request

Path Parameters

subscription_id
string
required

Subscription ID

Body

application/json
subscription_id
string

Subscription ID

merchant_id
string

Merchant unique identifier

price_id
string

Target pricing ID

effective_type
string

Effective date

  • end_of_period: End of current period.
  • immediate: Immediate.
proration
string

Proration settings none: Do not invoice prorated amount. (The price difference is ignored and a full invoice for the new pricing will be generated at the end of the current billing cycle.) immediate: Invoice prorated amount immediately. (A prorated credit or charge will be invoiced based on the price difference.)

Response

OK

code
string

error code

message
string

error message

data
object