Subscriptions

Get Upcoming Subscription Payment

Preview the amount and date of the Subscription's next renewal charge. Returns null when the Subscription is not active or is set to cancel at the end of the current interval — in both cases there is no upcoming charge to preview. The amount reflects Stripe's live invoice preview at request time and can still change before the charge actually happens (e.g. proration from a mid-cycle plan change, a coupon expiring, or tax recalculation) — it is a forecast, not a guarantee.

Authorization

Public key
x-fngs-public-key<token>

In: header

Path Parameters

subscriptionIdOrNumber*string

Subscription identifier - the initial order number, exactly as returned in subscription.id. Omit the leading # the dashboard shows: a #-prefixed value passes validation but resolves to nothing. Payment-provider subscription ids are not accepted.

Response Body

application/json

application/json

GET
/v0/subscriptions/{subscriptionIdOrNumber}/upcomingPayment
curl -X GET "https://example.com/v0/subscriptions/ABC123DEF456/upcomingPayment"
{  "status": "success",  "data": {    "upcomingPayment": {      "value": 0,      "currency": "AFN",      "currencyDecimals": null,      "chargeDate": 0    }  }}

Get Subscription GET

Retrieve detailed information about a specific Subscription.

Update Subscription PATCH

Update Subscription items and handle proration behavior. Can modify prices, quantities, and add/remove items. The items array is the desired end state of the Subscription: items are paired to existing lines by offerId, missing ones are removed, and new ones are added (up to 20 total). All resulting items must share the same currency and billing period (recurring interval + interval count); otherwise the request is rejected with a 400.