Developer Docs

Create a subscription offer

post
https://api.inflowpay.com/subscription/offer

Creates a new subscription offer

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The name of the subscription offer

string
required

The description of the subscription offer

string
enum
required

The currency for the subscription offer

Allowed:
number
required
50 to 99999999

The amount in cents for the subscription offer

number
50 to 99999999

Optional one-off amount in cents charged on the first payment only. Subsequent renewals use amountInCents. Omit to charge amountInCents from the first payment.

string

FX authoring — the currency you priced this offer in (ISO 4217, case-insensitive). When set, sourceAmountInMinorUnits (and optionally sourceEntryFeesInMinorUnits) replace amountInCents / entryFeesInCents, and we convert to currency at the live exchange rate. Must differ from currency. A buyer paying in this currency sees approximately, not exactly, the figure you typed: rates move, and their payment is converted with the conversion fee applied while your price is set at the mid-market rate. Expect a small, consistently upward difference.

number
1 to 99999999

Recurring amount in MINOR units of sourceCurrency (29900 = 299.00 TRY; for zero-decimal currencies such as JPY, 29900 = ¥29900). Required when sourceCurrency is set.

number
1 to 99999999

Entry fees in MINOR units of sourceCurrency. Only meaningful alongside sourceCurrency.

string
enum
required

The billing interval for the subscription

Allowed:
number
required
1 to 365

The number of intervals between billing cycles. Maximum depends on the selected interval: day up to 365, week up to 52, month up to 12, year up to 3.

number
≥ 2

Number of billing cycles the customer is charged for before the subscription is cancelled. For example, with interval month, intervalCount 1 and cycleCount 12, the customer is billed monthly for 12 months, then the subscription ends. Omit for unlimited.

number
1 to 365

Free trial length in days applied to every subscription created from this offer. Omit to start billing immediately.

sessionCustomization
object

The customization of the checkout session for subscriptions from this offer

string

Optional statement descriptor (max 11 characters) shown on the customer's bank statement as 'INFLOWPAY* '. Falls back to the account-level statement descriptor if omitted.

string

The URL to redirect to after successful subscription first payment. This will be used as default for all subscriptions from this offer. Required by returnMode APP_RETURN, whose button and automatic redirect both aim at it.

string

The URL to redirect to after failed/cancelled subscription first payment. This will be used as default for all subscriptions from this offer.

string

App Store listing shown on the APP_INSTALL success screen of sessions created from this offer. APP_INSTALL requires this or playStoreUrl — one of the two is enough. A request that leaves APP_INSTALL without either is rejected.

string

Google Play listing shown on the APP_INSTALL success screen of sessions created from this offer. APP_INSTALL requires this or appStoreUrl — one of the two is enough. A request that leaves APP_INSTALL without either is rejected.

string
enum

Which success screen buyers see after paying on a session created from this offer. DEFAULT keeps the current confirmation page; APP_RETURN adds a 'Back to the app' button; APP_INSTALL shows the store badges and the email to sign in with. APP_RETURN requires a successUrl, APP_INSTALL requires appStoreUrl or playStoreUrl — a mode left without what it points at is rejected with 400. On the update endpoint the rule is applied to the merged result, so a patch that only switches the mode is fine when the stored values already satisfy it.

Allowed:
smartRetryConfig
object | null

Smart retry override for this offer: retry failed renewal invoices at decreasing amounts. Omit or null to inherit the account-level config; { enabled: false } disables it for this offer.

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?