Skip to content

Latest commit

 

History

History
27 lines (24 loc) · 2.59 KB

File metadata and controls

27 lines (24 loc) · 2.59 KB

# CreateSubscriptionRequest

Properties

Name Type Description Notes
quantity int The subscription quantity. Must be 1 or greater. Default is 1. [optional]
active bool If the subscription is active or not. Default is true [optional]
contact_id string Id of the contact to create the subscription for.
subscription_plan_id string Id of the product subscription plan.
billing_amount float The billing amount. Must be 0 or greater. Default is the price in the product subscription plan. [optional]
auto_charge bool If the subscription should auto charge on the next billing date. Default is true. [optional]
max_charge_attempts int Maximum number of charge attempts. Must be 1 or greater. Default is the configured [Max Retries] value. [optional]
days_between_retries int Number of days between charge attempts. Must be 1 or greater. Default is the configured [Num Days Between Retries] value. [optional]
start_date \DateTime The first day the subscription will bill. Must not be in the past. Default is today. [optional]
payment_method_id string Id associated with the payment method. Default is the contact's most recently used card, if auto charge is true. Default is 0 otherwise. [optional]
allow_tax bool Only works if the product associated with the product subscription is taxable. Default is false. [optional]
allow_duplicate bool If true, it will disable the check to see if there is already an identical subscription for the contact. Default is false. [optional]
lead_affiliate_id string The affiliate id for the lead of the subscription. Default is 0. [optional]
sale_affiliate_id string The affiliate id for the sale of the subscription. Default is 0. [optional]
shipping_address \Keap\Core\V2\Model\AddressRequest The shipping address for the subscription. [optional]
promo_code string The promo code for the subscription. [optional]
shipping_option_id string The shipping option ID for the subscription. [optional]
reason_stopped string The reason the subscription is no longer active. [optional]
custom_fields \Keap\Core\V2\Model\CustomFieldValue[] List of custom field values to apply to this subscription [optional]

[Back to Model list] [Back to API list] [Back to README]