Skip to content

Latest commit

 

History

History
22 lines (17 loc) · 2.67 KB

CreateSubscriptionRequest.md

File metadata and controls

22 lines (17 loc) · 2.67 KB
Raw

SquareConnect.CreateSubscriptionRequest

Description

Note: This model is in beta.

Defines parameters in a CreateSubscription endpoint request.

Properties

Name Type Description Notes
idempotency_key String A unique string that identifies this `CreateSubscription` request. If you do not provide a unique string (or provide an empty string as the value), the endpoint treats each request as independent. For more information, see Idempotency keys.
location_id String The ID of the location the subscription is associated with.
plan_id String The ID of the subscription plan. For more information, see Subscription Plan Overview.
customer_id String The ID of the `customer` profile.
start_date String The start date of the subscription, in YYYY-MM-DD format. For example, 2013-01-15. If the start date is left empty, the subscription begins immediately. [optional]
canceled_date String The date when the subscription should be canceled, in YYYY-MM-DD format (for example, 2025-02-29). This overrides the plan configuration if it comes before the date the subscription would otherwise end. [optional]
tax_percentage String The tax to add when billing the subscription. The percentage is expressed in decimal form, using a `'.'` as the decimal separator and without a `'%'` sign. For example, a value of 7.5 corresponds to 7.5%. [optional]
price_override_money Money A custom price to apply for the subscription. If specified, it overrides the price configured by the subscription plan. [optional]
card_id String The ID of the `customer](#type-customer) [card` to charge. If not specified, Square sends an invoice via email. For an example to create a customer and add a card on file, see Subscriptions Walkthrough. [optional]
timezone String The timezone that is used in date calculations for the subscription. If unset, defaults to the location timezone. If a timezone is not configured for the location, defaults to "America/New_York". Format: the IANA Timezone Database identifier for the location timezone. For a list of time zones, see List of tz database time zones. [optional]