Skip to main content
POST
/
{proxy_path_prefix}
/
rental_intents
curl --request POST \
  --url https://api.example.com/{proxy_path_prefix}/rental_intents \
  --header 'Content-Type: application/json' \
  --data '
{
  "variantId": 123456789,
  "option": {
    "globalID": "gid://supercycle/CalendarRental::RentalPeriod/1",
    "params": {
      "rental_start": "2025-01-01"
    }
  }
}
'
{
  "selling_plan_id": 1234,
  "available_item_count": 3
}
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. 
{
  "rental_periods": [
    {
      "global_id": "gid://supercycle/CalendarRental::RentalPeriod/1",
      ...
    },
    {
      "global_id": "gid://supercycle/CalendarRental::RentalPeriod/2",
      ...
    }
  ],
  "fixed_fees": [...]
}
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
<input name="selling_plan" type="hidden" value="SELLING_PLAN_ID">

Path Parameters

​
proxy_path_prefix
string
required

The Shopify proxy path prefix configured for the app (e.g., 'customer_portal')

Body

application/json
​
variantId
integer
required

Shopify ID of the variant to create a rental intent for

​
option
object
required

Response

Successful response with rental intent token details

​
available_item_count
integer
required

Number of available items for the variant

​
selling_plan_id
integer

Shopify selling plan ID (present for Calendar and Subscription). This will need to be added to the product form as a hidden property using an input such as <input name="selling_plan" type="hidden" value="SELLING_PLAN_ID">

​
deposit_variant_id
integer

Shopify variant ID for deposit (present for Subscription)

​
credit_cost
integer

Credit cost for membership rentals (present for Membership)

​
schedule
object