Attributes

Attribute

Description

id int

Unique identifier for the object.

agency_id int

The ID of the agency object that should be associated with this plan. Please contact your account manager for more information or to create agencies on your account.

product_id int

Associated product this plan belongs to.

active bool

Whether the plan is currently available for purchase.

agency_remit_rate int

The remit rate that will go back to your business while the rest will be paid to the agency.

amount int

The unit amount in cents to be charged, represented as a whole integer if possible.

apple_product_id string

If non-null, this is the linked product ID for Apple In‑App Purchase

available_online bool

Whether the plan is available on your site.

auto_renew bool

This dictates whether a subscription assigned to this plan will auto-renew or not when the subscription is initiated. The subscription can go back to auto-renew separately.

currency string

Three-letter ISO currency code, in lowercase. Must be a supported currency.

countries array

If plan is only available in certain countries, those will be listed in an array as ISO 3166-1 alpha-2 codes.

description string

A brief description of the plan.

domains array

A list of domain names (i.e domain.com or *.domain.com) that will be used in a free plan

entitlements array

The list of entitlements.

group_owner_plan_id int

The group owner plan ID.

gift_description string

The gift description.

image string

The link to the image.

interval string

The frequency at which a subscription is billed. Can be one of the following options: day, week, month, or year.

interval_count int

The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and interval_count=3 bills every 3 months.

ip_addresses array

A list of public IP addresses (i.e 192.168.1 or 192.168.10/26) that will be used in a free plan

metadata array

An array of metadata.

nickname string

The plan name.

renewal_strategy string

One of agency, digital, regular or single_shipment

shipments_per_interval int

The number of shipments per interval. This value will get decremented on every approved fulfillment by one on the subscription and will re-added once the invoice is regenerated every new interval.

trial_period_days int

The number of days that will be provided to the subscription as a trial.