Checkout

A Checkout Session represents your customer's session as they pay for one-time purchases or subscriptions through Checkout. We recommend creating a new Session each time your customer attempts to pay.

You can create a Checkout Session on your server and pass its ID to the client to begin Checkout.

Related guide: Checkout Quickstart.

Checkout Session Object

Checkout Session Object

{
  "id": "cs_a1U7SSk86e6DUcjD9Zg7c26WqxP13PEG0pIt2TvAGPmyK9kDnD4kGR4tri",
  "object": "checkout.session",
  "amount_total": 10.99,
  "cancel_url": "https://example.com/cancel",
  "created": 1671995248,
  "expires_at": 1671995248,
  "status": "expired",
  "success_url": "https://example.com/success",
  "url": "https://fanspay.io/checkout/cs_a1U7SSk86e6DUcjD9Zg7c26WqxP13PEG0pIt2TvAGPmyK9kDnD4kGR4tri",
  "transaction_status": "unconfirmed",
  "type": "payment"
}

Attributes

Attribute	Type	Description
id	string	Unique identifier for the object.
object	string	String representing the object’s type. Objects of the same type share the same value.
amount_total	number	Total of all items after discounts and taxes are applied.
cancel_url	string	If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.
created	number	Time at which the object was created. Measured in seconds since the Unix epoch.
expires_at	number	The time at which the Checkout Session will expire. Measured in seconds since the Unix epoch.
status	string	The status of the Checkout Session, one of open, completed or expired.
success_url	string	The URL the customer will be directed to after the payment or subscription creation is successful.
transaction_status	string	The transaction status of the Checkout Session is one of confirmed, or unconfirmed. You can use this value to decide when to fulfill your customer’s order.
type	string	The type of checkout session. payment, subscription or donation
url	string	The URL at which the user has to make the payment.

Create a Session

Create a checkout session

POSThttps://api.fanspay.io/v1/checkout/sessions

Authorization

Bearer

Body

application/json

cancel_urlstring (uri)

If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.

items*CheckoutSessionItems (array of CheckoutSessionItem (object))

A list of items the customer is purchasing. Use this parameter to pass one-time or recurring prices

success_url*string (uri)

The URL to which Fanspay should send customers when payment or setup is complete.

typeenum

The type of checkout session

paymentdonation

Response

200400401422500

OK

Body

application/json

idstring

objectenum

checkout.session

amount_totalnumber (float64)

cancel_urlstring (uri)

createdinteger (uint)

expires_atinteger (uint)

statusenum

opencompletedexpired

success_urlstring (uri)

transaction_statusenum

confirmedunconfirmed

typeenum

donationpayment

urlstring (uri)

Request

JavaScriptCurl

const response = await fetch('https://api.fanspay.io/v1/checkout/sessions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "items": [
        {
          "price": {
            "amount": 0,
            "product": {
              "name": "text"
            }
          }
        }
      ],
      "success_url": "https://example.com"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "object": "checkout.session",
  "amount_total": 0,
  "cancel_url": "https://example.com",
  "status": "open",
  "success_url": "https://example.com",
  "transaction_status": "confirmed",
  "type": "donation",
  "url": "https://example.com"
}