Skip to main content
Returns one subscription. Poll it after redirecting a customer to the checkout, or read it whenever you need the current period — but rely on webhooks for renewals rather than polling.

​
Path Parameters

​
string
required
The subscription_id returned by Create Subscription.

​
Response Fields

​
string
required
Identifier of the subscription.
​
string
required
One of incomplete, incomplete_expired, active, past_due, unpaid, canceled. See Statuses.
​
string
required
flouci (wallet) today; card once card recurring is available.
​
integer
required
Amount of each charge in millimes.
​
string
required
Always TND.
​
string
required
day, week, month or year.
​
integer
required
Number of interval units per cycle.
​
string
required
Plan name shown to the customer.
​
string
Optional description; empty string when none was given.
​
string | null
Your customer identifier, if you sent one.
​
string
required
Your reference for the subscription.
​
boolean
required
Whether the subscription was created with a test app.
​
timestamp
required
When the subscription was created.
​
timestamp | null
When the first charge was paid — the anchor of the billing cycle. null while incomplete.
​
timestamp | null
Start of the period the customer has paid for.
​
timestamp | null
End (exclusive) of the paid period.
​
timestamp | null
When the next renewal (or retry) is debited. null while a charge is in flight, and on terminal or unpaid subscriptions.
​
integer
required
Number of paid cycles, first charge included.
​
integer | null
Total number of payments for an installment plan; null for an open-ended subscription.
​
boolean
required
true when a cancellation is scheduled for the end of the current period.
​
timestamp | null
When the subscription was canceled.
​
string | null
Who canceled: merchant, customer or system.
​
string | null
Why: for example completed (max_cycles reached), dunning_exhausted, customer_wallet_closed or at_period_end.
​
object | null
The most recent charge, in the shape described on List Charges.
​
string
Only while status is incomplete. The first charge to pay.
​
string
Only while status is incomplete. The checkout to send the customer back to.
A subscription_id that does not belong to your merchant returns 404 subscription_not_found — never a 403 — so an identifier leaks nothing about other merchants.