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 entry fees in cents for the first payment. If set, the first payment will be entryFeesInCents, and subsequent recurring payments will be amountInCents. If not set, all payments will be amountInCents.

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

The number of cycles the customer will be billed for, if cycleCount is 12 for example if the interval is month and intervalCount is 1, the customer will be billed for 12 months and the subscription will be cancelled after 12 months

number
1 to 365

Trial period length in days for subscriptions created from this offer.

sessionCustomization
object

The customization of the checkout session for subscriptions from this offer

string
length ≤ 11

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.

string

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

Responses

Updated 2 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 2 months ago

Did this page help you?