Sign in
Memberships

Collect a joining fee

This endpoint is used to create the Stripe Checkout session for collecting a joining fee as well as any pro-rata fees. A stripe_session_id is returned which can be passed into the Stripe.js SDK to redirect the user to the checkout.

post/customers/memberships/{membershipId}/checkout-session/joining-fee

Response

The Stripe Checkout session was successfully created.

statusstring required

The status of the membership

account_idstring required

Stripe Connect account ID that owns the Checkout Session. Pass this to stripe.redirectToCheckout({ stripeAccount }) in the client so the redirect is scoped to the right merchant account. Tenants on a single Stripe account can ignore it.

urlstring required

The URL to get to the Stripe Checkout session

stripe_session_idstring required

The Stripe Checkout session ID

rate_frequencystring required

The frequency that this membership is billed. The duration is specified as an ISO8601 duration string. See https://en.wikipedia.org/wiki/ISO_8601#Durations

Example response

{
  "status": "needs_dd_mandate",
  "account_id": "acct_1Jmwv72UMaxwwwup",
  "stripe_session_id": "si_1234567890",
  "rate_price": {
    "amount": 1000,
    "currency": "GBP"
  },
  "rate_frequency": "P1M"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.