API Reference

Subscribe a customer to a plan

post
https://appapi.heymantle.com/v1/subscriptions
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

The Mantle plan ID to subscribe to.

string

The URL to redirect to after the subscription is created.

string

The Mantle discount ID to apply to the subscription.

boolean

Whether this will be a test charge in Shopify or test subscription in Stripe

number

The number of trial days to give at the beginning of the subscription.

string

The date and time the subscription was activated at. Used for backfilling free plans only, will not work with paid plans.

string

Deprecated, use billingProvider instead.

string
enum

The billing provider to use for the subscription.

Allowed:
boolean

Stripe only: Whether to use Stripe checkout sessions or not.

boolean

Stripe only: Whether to use the saved payment method or not.

string
enum

Stripe only: How to collect payment for this subscription.

Allowed:
boolean

Stripe only: Whether to automatically calculate tax.

paymentMethodTypes
array of strings

Stripe only: The payment method types to accept, example: ["card", "ach_debit"].

paymentMethodTypes
number

Stripe only: The number of days until the subscription is due when using send_invoice.

string
enum

Stripe only: Whether to require a payment method when creating the subscription.

Allowed:
string
enum

Stripe only: The proration behavior for the subscription, defaults to billingAccount.prorationBehavior or create_prorations.

Allowed:
boolean

Stripe only: Whether to require a billing address when creating the subscription.

string

Stripe only: The email address to prefill in the checkout session if no customer is found.

metadata
object

Stripe only: Metadata to associate with the subscription.

Headers
string
required

The App Id when you create an API key in your Mantle dashboard.

string
required

The API token you receive from your POST request to the /identify endpoint.

Responses

500

Internal Server Error

Updated 4 months ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?