Storefront API
Rental intent
Getting a rental intent token.
POST
To fetch a rental intent token, you will need the ID of the option that you are wanting to create a rental for, the option ID’s can be found under the configuration metafield of the product
product.metafields.supercycle.subscription_configuration
product.metafields.supercycle.membership_configuration
product.metafields.supercycle.calendar_configuration
Here is what the calendar_configuration
metafield looks like, each rental period option will have a global_id
.
The shopify selling plan ID (present for Calendar and Subscription) in the response will need to be added to the product form as a hidden property.
product-form.liquid
Path Parameters
The Shopify proxy path prefix configured for the app (e.g., 'customer_portal')
Body
application/json
Response
200
application/json
Successful response with rental intent token details
The response is of type object
.