Initiate subscription from offer in the server to server process

post

https://api.inflowpay.com/subscription/offer/{subscriptionOfferId}/initiate-server

ℹ️ Note: To transmit card information directly through this API (server-to-server), replace the default base URL with https://api-card.inflowpay.com — contact support to get the required authorization.

If you are not transmitting card information directly (e.g. you're using our SDK to collect card details), keep the default base URL.

Initiates a new subscription from an existing offer

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

subscriptionOfferId

string

required

Unique identifier of the subscription offer

Body Params

card

object

Card information for secure payment processing. All card data is automatically tokenized and encrypted before processing. Your card details are never stored or transmitted in plain text. Ignored if useCustomerPaymentMethod is true.

items

array of objects

The list of catalog references to purchase (priceId or productId + quantity), resolved against your catalog. Provide either products or items, not both.

items

customerEmail

string

required

Customer email address

savePaymentMethod

boolean

Whether to save the payment method. Cannot be used if useCustomerPaymentMethod is true.

useCustomerPaymentMethod

boolean

Whether to use the last saved customer payment method. Cannot be used if savePaymentMethod is true.

offSession

boolean

Off-session payment (payer absent), Merchant Initiated. Requires a saved payment method (useCustomerPaymentMethod) and that the merchant is allowed to use off-session payments. Cannot be combined with force3ds or with card information.

force3ds

boolean

Force an on-session (payer present) 3DS browser challenge. With card information the 3DS is forced even if it would not normally be required. With useCustomerPaymentMethod the browser 3DS is performed before charging. Cannot be combined with offSession.

billingCountry

string

required

Billing country code (ISO 3166-1 alpha-2)

postalCode

string

Billing postal code (required for some countries like US)

purchasingAsBusiness

boolean

required

Whether the purchase is for a business

businessName

string

Business name (required if purchasingAsBusiness is true)

taxId

string

Business tax ID (required if purchasingAsBusiness is true)

firstName

string

First name, is optional but can cause issues with the 3DS authentication if not provided

lastName

string

Last name, is optional but can cause issues with the 3DS authentication if not provided

metadatas

object

Optional metadata (key-value pairs)

autoConfirm

boolean

Auto-confirm the payment (default false). When enabled, the payment is processed immediately if no 3DS step is required, or right after a successful 3DS authentication.

pricingMode

string

enum

Defaults to TAX_EXCLUSIVE

Pricing mode for the products. TAX_EXCLUSIVE (default): Product prices are excluding tax (HT), tax is added on top to calculate the final amount. TAX_INCLUSIVE: Product prices include tax (TTC), tax is extracted from the total while keeping the final amount fixed.

Allowed:

threeDsSuccessUrl

string

URL to redirect to after successful 3DS authentication, only required if card information is provided

threeDsFailureUrl

string

URL to redirect to after failed 3DS authentication, only required if card information is provided

marketplaceFeeInCents

number

≥ 0

Connect only: explicit marketplace take on this payin in cents. Only the parent marketplace may set this for sub-merchant payins (X-On-Behalf-Of). When omitted, the marketplace default from settings applies at checkout success.

captureMode

string

enum

Defaults to AUTOMATIC

Capture mode for card payments. AUTOMATIC (default): funds are captured when the customer pays. MANUAL: funds are authorized at checkout and must be captured later via POST /api/payment/:paymentId/capture (full amount only).

Allowed:

statementDescriptor

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.

label

string

length between 1 and 255

Optional label for the subscription that overrides the offer name. If not provided, the subscription offer's name is used.

Responses

200Initiate subscription from offer in the server to server process successful

400Invalid input data

401Unauthorized - Invalid API key

404Resource not found