Skip to main content
POST
billing.subscription-item.update

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
subscriptionItemId
string
required

Item to update.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
quantity
integer
required

New unit quantity; unavailable for usage billing.

Required range: 1 <= x <= 1000000
invoiceImmediately
boolean
default:false

Charge the change now. Default false.

disableProrations
boolean
default:false

Apply the new price at renewal without prorating; overrides invoiceImmediately.

Response

The result

subscriptionItemId
string
required

Your subscription item ID.

subscriptionId
string
required

Parent subscription ID.

priceId
string
required

Applied price record ID.

quantity
number
required

Subscribed quantity.

usageBased
boolean
required

This item bills measured usage.

createdAt
string

Creation time, ISO 8601.

updatedAt
string

Last update, ISO 8601.