Inkress DevelopersSubscriptions · Charge now
API reference / Subscriptions
Charge now
POST/api/v1/billing_subscriptions/:uid/chargeno app scope
Charges the subscriber's saved card now, outside the cycle. The regular schedule doesn't move.
Path parameters
uidstringrequired
The subscription's uid.
Body
reference_idstringrequired
Your own ID for this charge. reference works too.
totalnumberrequired
Amount in the major unit.
Headers
Authorizationheaderrequired
Bearer with your secret key, or the merchant's OAuth token.
Idempotency-Keyheader
For subscriptions charged in the background: the same key and body don't charge twice.
Returns
Most subscriptions are charged straight away: status (the order's, e.g. paid), total, currency, reference, subscription_uid and subscription_status. Some are charged in the background: you get 202 with status: "queued" and the reference; poll Charge status.
Errors
401 | The key or token is missing, wrong or revoked, is for the other environment, or doesn't have the scope this endpoint needs. |
200 | state: "error" with Subscription Not Found, or why the charge failed. |
403 | This credential can't charge this subscription. |
409 | This reference_id was already used for a different charge. |
422 | The merchant can't take this charge. |