Subscription

Subscriptions

Flex API Reference

Welcome to the Flex API reference docs. Here you'll find all the endpoints exposed by Flex, learn how to use them and what they return.

Production Endpoint
https://api.withflex.com
Staging Endpoint
https://api-stg.withflex.com

List Subscriptions

Returns a list of subscriptions.

Parameters

No parameters available.

get/v1/subscriptions
RESPONSE
[]
Create Subscription
Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.


Subscriptions by default are created with the status of incomplete. After the first payment is made, the status will change to active or trialing
in the case where a subscription has a trial period.
Parameters
No parameters available.
post/v1/subscriptions
RESPONSE
[]
Cancel Subscription
Cancels a customer’s subscription at the end of the current period. The customer will not be charged again for the subscription.
Parameters
No parameters available.
delete/v1/subscriptions/{id}
RESPONSE
[]
Get Subscription
Retrieves the subscription with the given ID.
Parameters
No parameters available.
get/v1/subscriptions/{id}
RESPONSE
[]
Update Shipping RateList Subscriptions