Create a subscription
Asks a customer to agree once to be charged priceData.amount every priceData.interval, starting on startDate. The subscription starts as incomplete: the customer approves on their phone and it becomes active, or they decline or never answer and it becomes incomplete_expired after 7 days. The first charge must fall in the future. The customer pays the fee on every charge, so fee and totalAmount are fixed when the subscription is created and stay the same for its whole life. The reply is the same whether or not the customer’s number has an iSmartPay account, so it never tells you. Retrying is safe with the same reference and body: you get the same subscription back. The same reference with a different body is 409 idempotency_key_reused. At most 60 are created a minute, and at most 3 open and 10 a day for one customer. Sends subscription.created. Requires the mandates.write permission. Subscriptions are charged on a schedule only once your business is switched on for them; until then this answers 503 provider_unavailable.
/v1/subscriptionsAuthorizationBearer token (JWT) · headerrequiredA token from POST /v1/oauth/token on the iSmartPay identity service, obtained with an API credential's client id and secret.
Idempotency-KeystringrequiredA unique value you generate for this attempt, at most 255 characters. Send the same value when you retry the same request: it is answered once, however many times you send it. Reusing a value with a different body is refused with 409 idempotency_key_reused.
application/jsonreferencestringrequiredYour reference for this subscription. Creating again with the same reference and body returns the same subscription.
priceDataobjectrequiredShow propertiesHide properties
amountstringrequiredA decimal string in major units, charged every cycle before the fee.
currencystringrequiredintervalstringrequiredHow often to charge. A weekly subscription charges on the weekday of startDate. A monthly one charges on its day of the month, and on the last day of shorter months.
dayweekmonthintervalCountintegerOnly 1 is offered: one charge per interval.
1customerobjectrequiredShow propertiesHide properties
phonestringrequiredThe customer's Ghanaian mobile number, like 0244123456. For a wallet subscription it is the number verified on their iSmartPay account.
networkstringThe customer's network. Required for mobile_money, and not allowed for wallet.
mtntelecelpaymentMethodstringrequiredmobile_money charges the customer's mobile money number under an agreement their network holds. wallet charges their iSmartPay wallet, in GHS only.
mobile_moneywalletstartDatestring<date>requiredThe day of the first charge. It must fall in the future.
endDatestring<date>No charge after this day.
maxCyclesintegerStop after this many paid charges.
billingTimestringThe time of day to charge.
timezonestringAfrica/AccraUTCretryobjectShow propertiesHide properties
afterDaysinteger[]Days after the due date to try a failed charge again. Only [1], [1, 3], [1, 3, 7] and [] (no retries) are offered. Left out, it is [1, 3, 7].
pastDueBehaviorstringWhat happens when every retry of a cycle has failed.
cancelpausekeep_chargingdescriptionstringShown to the customer when they approve.
The subscription, usually incomplete.
idstringrequiredreferencestringrequiredstatusstringrequiredincomplete: waiting for the customer. incomplete_expired: they declined or never answered; see declineReason. trialing: approved, with the first charge still to come. active: charging on schedule. past_due: every retry of a cycle failed; pastDueBehavior says what happens next. unpaid: past due with pastDueBehavior keep_charging. paused: no charges. canceled: see cancelReason. completed: reached endDate or maxCycles.
incompleteincomplete_expiredtrialingactivepast_dueunpaidpausedcanceledcompletedcustomerobjectrequiredShow propertiesHide properties
phonestringrequirednetworkstringmtntelecelpaymentMethodstringrequiredmobile_moneywalletpriceDataobjectrequiredShow propertiesHide properties
amountstringrequiredA decimal string in major units.
currencystringrequiredintervalstringrequireddayweekmonthintervalCountintegerrequired1feestringrequiredThe fee the customer pays on each charge, fixed when the subscription was created. A decimal string in major units.
totalAmountstringrequiredWhat the customer pays on each charge: priceData.amount plus fee.
startDatestring<date>requiredendDatestring<date>maxCyclesintegerbillingTimestringrequiredtimezonestringrequiredretryobjectrequiredShow propertiesHide properties
afterDaysinteger[]pastDueBehaviorstringrequiredcancelpausekeep_chargingdescriptionstringconsentobjectrequiredHow the customer agrees.
Show propertiesHide properties
channelstringrequirednetwork: their network asks them to approve. first_charge: the first charge's prompt is the agreement. pin: they approve with their PIN in the iSmartPay app.
networkfirst_chargepinexpiresAtstring<date-time>When the request lapses if the customer has not answered.
consentedAtstring<date-time>nextChargeAtstring<date-time> | nullrequiredWhen the next charge is due, or null when none is.
cyclesChargedintegerrequiredHow many cycles have been paid.
cancelAtPeriodEndbooleanrequiredcancelAtstring<date-time>When a subscription set to end at its period end will end.
cancelReasonstringPresent when canceled: you canceled it, the customer canceled the agreement with their network, or iSmartPay did.
businessnetworkplatformdeclineReasonstringPresent when incomplete_expired.
declinedno_responsepausedBystringPresent when paused. platform means iSmartPay stopped charging; contact support.
businessplatformcreatedAtstring<date-time>requiredupdatedAtstring<date-time>requiredThe request is not valid. message says which field.
errorobjectrequiredShow propertiesHide properties
codestringrequiredA stable, machine-readable code. Branch on this, not on the message. Codes include invalid_input, unauthenticated, forbidden, environment_mismatch, not_found, rate_limited, idempotency_key_reused, request_in_flight, limits_missing, limits_unusable, tier_ineligible, transaction_limit_exceeded, daily_limit_exceeded, monthly_limit_exceeded, new_destination_limit, business_suspended, business_deactivated, environment_unknown, duplicate_reference, provider_error, provider_timeout, destination_not_verified, destination_verification_unavailable, upstream_timeout and internal.
messagestringrequiredReadable detail for a person. For any 5xx it is always the fixed text internal server error.
The token is missing, expired or not valid. Get a new one from the token endpoint.
errorobjectrequiredShow propertiesHide properties
codestringrequiredA stable, machine-readable code. Branch on this, not on the message. Codes include invalid_input, unauthenticated, forbidden, environment_mismatch, not_found, rate_limited, idempotency_key_reused, request_in_flight, limits_missing, limits_unusable, tier_ineligible, transaction_limit_exceeded, daily_limit_exceeded, monthly_limit_exceeded, new_destination_limit, business_suspended, business_deactivated, environment_unknown, duplicate_reference, provider_error, provider_timeout, destination_not_verified, destination_verification_unavailable, upstream_timeout and internal.
messagestringrequiredReadable detail for a person. For any 5xx it is always the fixed text internal server error.
The request was understood and refused. Common causes: the token is not an API credential's (forbidden); the credential is for the other environment (environment_mismatch); it does not have the permission this operation needs (forbidden); a limit was reached (limits_missing, limits_unusable, tier_ineligible, transaction_limit_exceeded, daily_limit_exceeded, monthly_limit_exceeded, new_destination_limit); or iSmartPay has suspended or deactivated the business (business_suspended, business_deactivated). A suspended business's API credentials stop exchanging for tokens, so a request made with a token issued just before the suspension is refused with business_suspended.
errorobjectrequiredShow propertiesHide properties
codestringrequiredA stable, machine-readable code. Branch on this, not on the message. Codes include invalid_input, unauthenticated, forbidden, environment_mismatch, not_found, rate_limited, idempotency_key_reused, request_in_flight, limits_missing, limits_unusable, tier_ineligible, transaction_limit_exceeded, daily_limit_exceeded, monthly_limit_exceeded, new_destination_limit, business_suspended, business_deactivated, environment_unknown, duplicate_reference, provider_error, provider_timeout, destination_not_verified, destination_verification_unavailable, upstream_timeout and internal.
messagestringrequiredReadable detail for a person. For any 5xx it is always the fixed text internal server error.
idempotency_key_reused: the key was used before with a different body. request_in_flight: a request with this key is still being processed, so retry shortly. duplicate_reference: the reference is already used by a different request, so choose a new one; sending the same body again under a new key replays the first answer.
errorobjectrequiredShow propertiesHide properties
codestringrequiredA stable, machine-readable code. Branch on this, not on the message. Codes include invalid_input, unauthenticated, forbidden, environment_mismatch, not_found, rate_limited, idempotency_key_reused, request_in_flight, limits_missing, limits_unusable, tier_ineligible, transaction_limit_exceeded, daily_limit_exceeded, monthly_limit_exceeded, new_destination_limit, business_suspended, business_deactivated, environment_unknown, duplicate_reference, provider_error, provider_timeout, destination_not_verified, destination_verification_unavailable, upstream_timeout and internal.
messagestringrequiredReadable detail for a person. For any 5xx it is always the fixed text internal server error.
The purchase cannot be made as asked: product_not_sellable (the product is not on sale now), amount_out_of_range (outside the product's price, min or max), currency_not_supported (only GHS is sold), beneficiary_invalid (the product cannot be sold to this number) or fee_unpriceable (the fee cannot be worked out right now; retry later).
errorobjectrequiredShow propertiesHide properties
codestringrequiredA stable, machine-readable code. Branch on this, not on the message. Codes include invalid_input, unauthenticated, forbidden, environment_mismatch, not_found, rate_limited, idempotency_key_reused, request_in_flight, limits_missing, limits_unusable, tier_ineligible, transaction_limit_exceeded, daily_limit_exceeded, monthly_limit_exceeded, new_destination_limit, business_suspended, business_deactivated, environment_unknown, duplicate_reference, provider_error, provider_timeout, destination_not_verified, destination_verification_unavailable, upstream_timeout and internal.
messagestringrequiredReadable detail for a person. For any 5xx it is always the fixed text internal server error.
Too many requests for this credential. Wait the number of seconds in the Retry-After header, then try again.
errorobjectrequiredShow propertiesHide properties
codestringrequiredA stable, machine-readable code. Branch on this, not on the message. Codes include invalid_input, unauthenticated, forbidden, environment_mismatch, not_found, rate_limited, idempotency_key_reused, request_in_flight, limits_missing, limits_unusable, tier_ineligible, transaction_limit_exceeded, daily_limit_exceeded, monthly_limit_exceeded, new_destination_limit, business_suspended, business_deactivated, environment_unknown, duplicate_reference, provider_error, provider_timeout, destination_not_verified, destination_verification_unavailable, upstream_timeout and internal.
messagestringrequiredReadable detail for a person. For any 5xx it is always the fixed text internal server error.
Something failed on our side. The message is fixed. If the request was a POST, retry with the same Idempotency-Key and body.
errorobjectrequiredShow propertiesHide properties
codestringrequiredA stable, machine-readable code. Branch on this, not on the message. Codes include invalid_input, unauthenticated, forbidden, environment_mismatch, not_found, rate_limited, idempotency_key_reused, request_in_flight, limits_missing, limits_unusable, tier_ineligible, transaction_limit_exceeded, daily_limit_exceeded, monthly_limit_exceeded, new_destination_limit, business_suspended, business_deactivated, environment_unknown, duplicate_reference, provider_error, provider_timeout, destination_not_verified, destination_verification_unavailable, upstream_timeout and internal.
messagestringrequiredReadable detail for a person. For any 5xx it is always the fixed text internal server error.
A service behind the API did not answer usably. If the request was a POST, retry with the same Idempotency-Key and body. A party lookup the provider rejects is provider_error.
errorobjectrequiredShow propertiesHide properties
codestringrequiredA stable, machine-readable code. Branch on this, not on the message. Codes include invalid_input, unauthenticated, forbidden, environment_mismatch, not_found, rate_limited, idempotency_key_reused, request_in_flight, limits_missing, limits_unusable, tier_ineligible, transaction_limit_exceeded, daily_limit_exceeded, monthly_limit_exceeded, new_destination_limit, business_suspended, business_deactivated, environment_unknown, duplicate_reference, provider_error, provider_timeout, destination_not_verified, destination_verification_unavailable, upstream_timeout and internal.
messagestringrequiredReadable detail for a person. For any 5xx it is always the fixed text internal server error.
The API is temporarily unable to tell which environment it serves (environment_unknown), utility purchases are not available right now (utilities_unavailable), a settlement destination could not be name-checked just now (destination_verification_unavailable; retry the same request), or hosted checkout is not set up on this deployment (checkout_unavailable). Retry shortly, except for checkout_unavailable, which lasts until the deployment is configured.
errorobjectrequiredShow propertiesHide properties
codestringrequiredA stable, machine-readable code. Branch on this, not on the message. Codes include invalid_input, unauthenticated, forbidden, environment_mismatch, not_found, rate_limited, idempotency_key_reused, request_in_flight, limits_missing, limits_unusable, tier_ineligible, transaction_limit_exceeded, daily_limit_exceeded, monthly_limit_exceeded, new_destination_limit, business_suspended, business_deactivated, environment_unknown, duplicate_reference, provider_error, provider_timeout, destination_not_verified, destination_verification_unavailable, upstream_timeout and internal.
messagestringrequiredReadable detail for a person. For any 5xx it is always the fixed text internal server error.
The request took too long. If it was a POST, its outcome is unknown: retry with the same Idempotency-Key and body, or read it back by reference. A party lookup the provider does not answer is provider_timeout: check again before relying on it.
errorobjectrequiredShow propertiesHide properties
codestringrequiredA stable, machine-readable code. Branch on this, not on the message. Codes include invalid_input, unauthenticated, forbidden, environment_mismatch, not_found, rate_limited, idempotency_key_reused, request_in_flight, limits_missing, limits_unusable, tier_ineligible, transaction_limit_exceeded, daily_limit_exceeded, monthly_limit_exceeded, new_destination_limit, business_suspended, business_deactivated, environment_unknown, duplicate_reference, provider_error, provider_timeout, destination_not_verified, destination_verification_unavailable, upstream_timeout and internal.
messagestringrequiredReadable detail for a person. For any 5xx it is always the fixed text internal server error.