Attributes

AttributeDescription
id intUnique identifier for the object.
active boolWhether the product is available for purchase. Can be (1) for active, and (0) for inactive.
address_required boolWhether a shipping address is required when subscribing to only plans associated to this product.
description stringThe product’s description, meant to be displayable to the customer. Use this field to optionally store a long-form explanation of the product being sold for your own rendering purposes.
is_hidden boolWhether the product is hidden in the platform.
is_imported boolWhether the product was imported.
name stringName of the product which will appear on your site.
name_internal stringInternal reference name for the product (not visible to public)
language stringProduct language
package_dimensions string
shippable boolWhether the product is shippable.
statement_descriptor stringWhat appears on your customers' bank statements.
unit_label string
countries arrayList of countries the product is available for purchase.
image stringImage of the product URL uploaded into the platform
plans arrayAlways expanded, this is a list of Plans associated to this product.
old_provider_id string
import_unique_id string
The current/old external product ID associated with a migrated product.
is_importedboolDefine if the product is imported or not