Create subscription session

post

https://checkout-api.frisbii.com/v1/session/subscription

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Errors

The operation can generate the following errors beside the generic HTTP error codes described here.

Error code	HTTP code	Description
601	400	Could not find any available payments methods. Payment options must be configured in the administration to create a session
603	404	Configuration not found
604	400	Card-on-file not allowed for session storing credentials
79	400	Invoice already settled
105	400	Invoice already authorized
29	400	Invoice already cancelled
71	400	The customer is deleted
11	400	Duplicate customer handle provided
18	400	Customer could not be determined from either reference, create customer object or payment method source
99	400	Customer object given does not match handle of existing customer or handle given does not match existing customer reference
24	400	No amount or order lines was provided
100	400	Amount change is not allowed when charging an existing invoice
80	400	Existing charge has processing transactions
72	400	Currency change not allowed on existing invoice or charge
9	404	The customer is not found
10	404	Subscription plan provided not found
11	400	Duplicate handle - subscription handle, additional cost handle or subscription add-on handle already used
14	400	End date must be in the future
19	404	Customer card provided as source but cannot be found
34	400	Invalid card token provided as source
37	400	Start date if provided cannot be more than one period in the past, e.g. one month.
75	400	Subscription not eligible for invoice. This error is returned if the conditional_create parameter is set to true, but the subscription does not have a plan resulting in an invoice right away. This is the case for subscription plans with fixed day billing. E.g. on the first of every month.
83	404	Discount not found
85	400	Multiple discounts not allowed
86	404	Coupon not found or not eligible
87	400	Coupon already used
133	404	Add-on not found
114	400	Add-on already added or multiple occurences of same add-on in request without explicit unique subscription add-on handle
115	400	Add-on quantity not allowed for on-off add-on type
116	400	Add-on not eligible for subscription plan

Body Params

configuration

string

Optional handle for a checkout configuration defined in the admin app to be used for this session

locale

string

Optional locale for session. E.g. en_GB, da_DK, es_ES. Defaults to configuration locale or account locale.

ttl

string

Optional time-to-live duration. The session will expire after the duration from creation, meaning that payment attempts cannot be initiated after this duration. Notice though, that payments initiated within the time-to-live duration might finish after the TTL E.g. MobilePay Online flows. The duration must be given in the following notation: PTxS - x seconds, PTxM - x minutes, PTxH - x hours or PxD - x days. E.g. PT3H (three hours). The default time-to-live is three months.

phone

string

Phone number to use for payment methods able to use a prefilled phone number. E.g. MobilePay, Vipps and Swish. If no explicit phone number is defined, the phone number for the customer entity will be used.

subscription

string

Handle for existing subscription to activate, add payment method to or change payment method for. Either this argument must be provided or prepare_subscription.

accept_url

string

If checkout is opened in separate window the customer will be directed to this page after success

cancel_url

string

If checkout is opened in separate window the customer will be directed to this page if the customer cancels

payment_methods

array of strings

Optional list of payment methods to use for the checkout session. Format:
<payment_methods> = list of <payment_method>
<payment_method> = [sca-|nosca-]<payment_name>
<payment_name> = The id of payment method, e.g. dankort
See https://docs.frisbii.com/docs/checkout-payment-methods for full documentation

payment_methods

card_on_file

string

Reference to existing card payment method (ca_xxx) to use instead of having cardholder enter card data. CVV may still be required from cardholder.

card_on_file_require_cvv

boolean

Require cvv from cardholder for card-on-file

card_on_file_require_exp_date

boolean

Require expiration date for card-on-file

button_text

string

Optional alternative button text. Maximum length 32 characters.

recurring_average_amount

int64

≥ 0

For cost based acquirer agreement selection this argument can be used to define the amount used in calculating the least expensive agreement for future recurring payments. Can only be used for sessions saving a payment method for later use. Must be given in minor unit for currency.

sca_data

object

Customer data used in strong customer authentication to reduce the need for a lengthy authentication process and ensure less fraud. The data is not stored at Reepay and only used in the process of strong customer authentication. The data is used by card issuer to determine if a frictionless authentication flow can be used.

session_data

object

Object to define payment type specific parameters

payment_method_reference

string

Optional reference given to the created payment method in case a recurring payment method is created by the session. Session id will be used by default if not defined. Max length 64 with allowable characters [a-zA-Z0-9_.-@].

account_funding

boolean

Indicates that Account Funding Transaction (AFT) is requested.
It only can be used for instant settle (i.e. 'settle' = true)

account_funding_information

object

Optional sender information required for Account Funding Transaction (AFT).
If not provided when requesting account funding transaction with account_funding=true,
information will be gathered from invoice billing address and customer.

agreement_filter

array of strings

Optional list of agreement ids to filter which agreements will be used for card payments.

agreement_filter

offline_agreement_filter

array of strings

Optional list of offline agreement handles to filter which options are shown to the consumer.

offline_agreement_filter

vipps_epayment_agreement_filter

array of strings

Optional list of vipps epayment agreement ids to filter which options are shown to the consumer.

vipps_epayment_agreement_filter

allowed_ip

string

Optional IP address to restrict the use of the session to

force_mobile

boolean

Optionally force use of mobile app URLs for payment methods supporting this.

require_cardholder_name

boolean

Require name on card for credit card payments. The argument will be ignored for card-on-file sessions.

prepare_subscription

object

Prepare subscription object. Either this argument must be provided or reference to existing subscription in subscription. For prepare subscription object see: https://docs.frisbii.com/reference/preparesubscription

show_terms

boolean

Toggle whether terms should be shown and acceptance required. If not defined the default is to show terms if no payment method has previously been added. Set this option to false if terms have already been showed in own system.

show_subscription_details

boolean

Toggle whether to show subscription details. Default is to show details. Set this option to false if subscription details have already been shown in own system.

Responses

Errors

200Successful operation

400Invalid request, see error codes at https://api.frisbii.com/v1/error_codes

401None or invalid credentials provided in access to secured resource

403Not authorized to perform resource operation

404Resource or referenced resource not found, see error codes at https://api.frisbii.com/v1/error_codes

500Internal service error, error is reported automatically to Frisbii