Inkress DevelopersSubscriptions · Charge status
API reference / Subscriptions
Charge status
GET/api/v1/billing_subscriptions/:uid/charges/:referenceno app scope
The outcome of a charge that answered 202 queued. Poll it with the same reference.
Path parameters
uidstringrequired
The subscription's uid.
referencestringrequired
The reference the charge returned.
Headers
Authorizationheaderrequired
Bearer with your secret key, or the merchant's OAuth token.
Returns
status, the reference, the order once there is one (id, total, customer_total, fee_total, currency, status) and a failure_reason when it didn't go through.
| status | Meaning |
|---|---|
queued | Waiting to run. |
processing | Running or being retried. |
succeeded | Paid. |
declined | The card was declined. |
under_review | Inkress is checking the result. |
failed | It didn't run; failure_reason says why. |
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. |
403 | This credential can't see this subscription's charges. |
404 | Charge Not Found or Subscription Not Found. |