Checkouts

#The checkout object

Attributes

• analytics_dataobject
  Analytics data containing amongst other things the utm_params
  Show child attributesHide child attributes1

  • utm_paramsarray of objects
    An array containing utm_parameters which are commonly used to store the details of an acquisition campaign.
    Show child attributesHide child attributes7

    • utm_campaignstring
      The utm campaign details.
    • utm_contentstring
      The utm content.
    • utm_data_sourcestring
      The source of the campaign parameter.
    • utm_sourcestring
      The utm source.
    • utm_mediumstring
      The utm medium.
    • utm_termstring
      The utm term.
    • utm_timestampstring
      The utm timestamp.
• applied_discountobject
  Details of the discount code applied to the checkout.
  Show child attributesHide child attributes5

  • amountstring
    The standardised financial value of the discount.
    If the discount is a percentage the amount will be in the presentment currency of the checkout. If the discount is fixed it will be in the store currency.
  • applicableboolean
    Whether the discount is valid for the checkout.
  • non_applicable_reasonstring
    If applicable is false provides more details on the reason for rejection.
  • valuestring
    The value of the discount.
    This is not necessarily a financial value. It depends on the value_type. See amount for the financial translation of the discount.
  • value_typestring
    The type of discount to be applied.
    Possible values

    fixed_amountpercentage
• billing_addressobject
  Billing address for the checkout.
  Show child attributesHide child attributes22

  • idinteger
    Unique numeric identifier for the Address.
  • address1string
    The street associated with the Address.
  • address2string
    Any additional information associated with the shipping address.
  • cart_notestringBigCommerceCustomRCS
    The note that that will be passed to the note field of Orders made within the Address.
    cart_note is not currently honored when sent to the Shopify contract api (SCI).
  • citystring
    The city associated with the shipping address.
  • companystring
    The company associated with the shipping address.
  • countrystring
    The country associated with the shipping address.
  • country_codestring
    The 2-letter country code.
  • customer_idinteger
    Unique numeric identifier for the Customer associated with the Address.
  • discount_idinteger
    Unique numeric identifier of Discount that is applied on the Address.
  • first_namestring
    The customer’s first name associated with the address.
  • last_namestring
    The customer’s last name associated with the address.
  • note_attributesarray of objects
    Extra information that is added to the order.
    Show child attributesHide child attributes2

    • namestring
      The name for the note_attribute.
    • valuestring
      The value for the associated note_attribute.
  • phonestring
    The phone number associated with the address.
  • presentment_currencystringSCI
    Presentment currency is the currency used to display prices to the associated on a storefront and at checkout.
    Only set if the currency is different from the store-level currency. Else, will default to store-level currency.
  • provincestring
    The state or province associated with the address.
  • shipping_lines_overridearray of objects
    Used when shipping rates need to be overridden. If this parameter has value null, rates will be fetched when a related Charge is created or regenerated
    Show child attributesHide child attributes3

    • codestring
      The code of the associated shipping line.
    • pricestring
      The price (in store’s currency) of the associated shipping line.
    • titlestring
      The title of the associated shipping line.
  • zipstring
    The zip or postal code associated with the address.
  • cart_attributesarray
    Additional information added to an initial order.
    Important: This field will be deprecated. Please use note_attributes instead.
  • created_atdatetime
    The date and time when the address was created.
  • original_shipping_lines
    Shipping line details.
    Important: This field will be deprecated. Please use shipping_lines_override instead.
  • updated_atdatetime
    The date and time when the Address was last updated.
• buyer_accepts_marketingboolean
  Serves as the audit trail for a buyer email marketing's communication opt-in
• charge_idinteger
  The id associated to the Charge generated as a by-product of a Checkout being processed.
  This value will remain null as long as the Checkout has not been completed.
• completed_attimestamp
  The timestamp at which the Checkout was processed.
  This value will remain null as long as the Checkout has not been completed.
• created_attimestamp
  The timestamp at which the Checkout was created.
• currencystring
  The presentment currency of the Checkout.
  This will also be the currency of the resulting Address and Subscriptions created by the checkout processing.
• discount_codestring
  Discount code to be used on the checkout, e.g. “DISCOUNT20”.
• emailstring
  Email address for the customer.
• external_checkout_idstring
  Field which will hold the value of the corresponding external checkout or cart if the checkout was branched from another platform.
• external_checkout_sourcestring
  Source of the creation of the checkout.
  Possible values

  big_commerceheadlessshopify
• external_customer_idstring
  Customer identifier in the source platform issuing the checkout.
  This field is useful for mapping to your customer id in your central CRM, ERP or any other commerce platform where you maintain your customer's profiles.
• line_itemsarray of objects
  The details of the different items being purchased by the user.
  Show child attributesHide child attributes29

  • charge_interval_frequencyinteger
    frequency at which the user will pay for his subscription on the item.
  • cutoff_day_of_monthinteger
    Day of the month a customer should be charged. Used only if the user is to be charged on a specific day.
    Only valid if the order_interval_unit is month
  • cutoff_day_of_weekinteger
    Day of the week a customer should be charged. Used only if the user is to be charged on a specific day.
    Only valid if the order_interval_unit is week
  • expire_after_specific_number_of_chargesinteger
    Number of charges to be processed for the resulting subscription until it expires.
    Used if the user subscription on the item should stop after a few iterations. Frequently used for gift subscriptions. e.g. you offer a 3-month flower subscription to a loved one you can setup expire_after_specific_number_of_charges to 3 and a monthly frequency.
  • first_recurring_charge_delayinteger
    Add a delay (in days) to the first recurring transaction on the subscription.
    This number will get added to the already projected next charge date. e.g. if you create a monthly subscription and set the first_recurring_charge_delay to 7, the next transaction for that subscription will be 1months and 7 days post checkout.
  • fulfillment_servicestring
    Name of fulfillment service.
  • gramsinteger
    Weight in grams of the item.
    Only valid for physical items.
  • imagestring
    Image link of the item which shows on the checkout.
  • line_pricestring
    The price of the item.
  • order_day_of_monthinteger
    Specify if the order should be processed on a specific day of the month.
    Only valid if the order_interval_unit is month.
  • order_day_of_weekinteger
    Specify if the order should be processed on a specific day of the week.
    Only valid if the order_interval_unit is week.
  • order_interval_frequencyinteger
    Frequency at which the user will receive orders for the subscription.
  • order_interval_unitstring
    Unit scale for the frequency of orders and charges.
    Possible values

    dayweekmonth
  • original_pricestring
    Original price of the item.
    e.g. this number will be different from the price if you offer a subscribe&save option and this line_item is for a subscription to the product.
  • pricestring
    Price charged for the item at checkout.
  • product_idinteger
    Product identifier.
    Found under shopify_product_id ir product_id in the Product object.
  • product_typestring
    Category of the product defined in PIM.
  • propertiesarray of objects
    An array of Property object containing customer information for an item that has been added to the checkout.
    Show child attributesHide child attributes2

    • namestring
      The name of the property.
    • valuestring
      The url reference for the image (CDN or other).
  • quantityinteger
    The number of units of the product that is purchased.
  • recurring_priceinteger
    Recurring price of the subscription.
  • requires_shippingboolean
    Marks if an item needs to be packed and delivered.
  • skustring
    A unique identifier of the item in the fulfillment. Stands for Stock Keeping Unit.
  • tax_codestring
    Tax category of the product.
  • taxableboolean
    Whether tax applies to the product.
  • titlestring
    The title of the product.
  • typestring
    The type of the item.
    Possible values

    SUBSCRIPTIONONETIME
  • variant_idinteger
    Id of the product variant.
  • variant_titlestring
    The title of the product variant.
  • vendorstring
    The vendor name.
    Useful for platforms managing several vendors
• notestring
  Note used to store free text notes.
• note_attributesarray of objects
  Structured note attributes.
  Show child attributesHide child attributes2

  • namestring
    The name for the note_attribute.
  • valuestring
    The value for the associated note_attribute.
• payment_processorstring
  Name of the payment processor selected for the checkout.
  Will remain null until payment details have been filled in.
• payment_processor_customer_idstring
  Identifier for the customer on the payment processor platform.
  Will remain null until the checkout has been processed.
• payment_processor_transaction_idstring
  Identifier for the transaction on the payment processor platform.
  Will remain null until the checkout has been processed.
• phonestring
  Customer phone number.
• requires_shippingboolean
  Signals if the Order resulting from the processing of the checkout will need to be shipped aka packed and delivered.
  This relies on whether any of the line_items requires_shipping.
• shipping_addressobject
  Shipping address for the checkout.
  Show child attributesHide child attributes22

  • idinteger
    Unique numeric identifier for the Address.
  • address1string
    The street associated with the Address.
  • address2string
    Any additional information associated with the shipping address.
  • cart_notestringBigCommerceCustomRCS
    The note that that will be passed to the note field of Orders made within the Address.
    cart_note is not currently honored when sent to the Shopify contract api (SCI).
  • citystring
    The city associated with the shipping address.
  • companystring
    The company associated with the shipping address.
  • countrystring
    The country associated with the shipping address.
  • country_codestring
    The 2-letter country code.
  • customer_idinteger
    Unique numeric identifier for the Customer associated with the Address.
  • discount_idinteger
    Unique numeric identifier of Discount that is applied on the Address.
  • first_namestring
    The customer’s first name associated with the address.
  • last_namestring
    The customer’s last name associated with the address.
  • note_attributesarray of objects
    Extra information that is added to the order.
    Show child attributesHide child attributes2

    • namestring
      The name for the note_attribute.
    • valuestring
      The value for the associated note_attribute.
  • phonestring
    The phone number associated with the address.
  • presentment_currencystringSCI
    Presentment currency is the currency used to display prices to the associated on a storefront and at checkout.
    Only set if the currency is different from the store-level currency. Else, will default to store-level currency.
  • provincestring
    The state or province associated with the address.
  • shipping_lines_overridearray of objects
    Used when shipping rates need to be overridden. If this parameter has value null, rates will be fetched when a related Charge is created or regenerated
    Show child attributesHide child attributes3

    • codestring
      The code of the associated shipping line.
    • pricestring
      The price (in store’s currency) of the associated shipping line.
    • titlestring
      The title of the associated shipping line.
  • zipstring
    The zip or postal code associated with the address.
  • cart_attributesarray
    Additional information added to an initial order.
    Important: This field will be deprecated. Please use note_attributes instead.
  • created_atdatetime
    The date and time when the address was created.
  • original_shipping_lines
    Shipping line details.
    Important: This field will be deprecated. Please use shipping_lines_override instead.
  • updated_atdatetime
    The date and time when the Address was last updated.
• shipping_address_validationsobject
  Results of the shipping address validation.
  only available once the shipping address has been filled in.
  Show child attributesHide child attributes2

  • country_is_supportedboolean
    checks if country is in the list of shipping countries.
  • upsboolean
    ups supported.
• shipping_linearray of objects
  Shipping lines.
  Show child attributesHide child attributes5

  • codestring
    The code associated with the shipping line of the charge.
  • pricestring
    The price of the shipping line.
  • sourcestring
    The source of the shipping line.
  • titlestring
    The title of the shipping line.
  • taxablestring
    A boolean indicating if the shipping line is taxable.
• shipping_ratestring
  The name of the shipping rate applied.
• tax_linesarray of objects
  Tax details.
  Show child attributesHide child attributes4

  • pricestring
    The total tax associated with the listed jurisdiction.
  • ratestring
    The tax rate associated with the listed jurisdiction.
  • titlestring
    The title/name of the taxing jurisdiction.
  • unit_pricestring
    The tax associated with a single unit attributed to the listed jurisdiction.
• taxes_includedboolean
  Whether taxes are included in the price of the line_items
• tokenstring
  Unique identifier of the checkout. Used by the update and processing and update endpoints.
• total_pricestring
  Total amount for the full checkout transaction
• total_taxstring
  Total amount of tax for the full checkout transaction
• updated_attimestamp
  The timestamp at which the Checkout was last updated.

#Create a checkout

Body parameters

• analytics_dataobject
  Analytics data containing amongst other things the utm_params.
  analytics_data will be added to Subscription, Customer and Charge objects created as a result of the successful processing of the Checkout.
  Show child attributesHide child attributes1

  • utm_paramsarray of objects
    An array containing utm_parameters which are commonly used to store the details of an acquisition campaign.
    Show child attributesHide child attributes7

    • utm_campaignstring
      The utm campaign details.
    • utm_contentstring
      The utm content.
    • utm_data_sourcestring
      The source of the campaign parameter.
    • utm_sourcestring
      The utm source.
    • utm_mediumstring
      The utm medium.
    • utm_termstring
      The utm term.
    • utm_timestampstring
      The utm timestamp.
• billing_addressobject
  Billing address for the checkout.
  Show child attributesHide child attributes22

  • idinteger
    Unique numeric identifier for the Address.
  • address1string
    The street associated with the Address.
  • address2string
    Any additional information associated with the shipping address.
  • cart_notestringBigCommerceCustomRCS
    The note that that will be passed to the note field of Orders made within the Address.
    cart_note is not currently honored when sent to the Shopify contract api (SCI).
  • citystring
    The city associated with the shipping address.
  • companystring
    The company associated with the shipping address.
  • countrystring
    The country associated with the shipping address.
  • country_codestring
    The 2-letter country code.
  • customer_idinteger
    Unique numeric identifier for the Customer associated with the Address.
  • discount_idinteger
    Unique numeric identifier of Discount that is applied on the Address.
  • first_namestring
    The customer’s first name associated with the address.
  • last_namestring
    The customer’s last name associated with the address.
  • note_attributesarray of objects
    Extra information that is added to the order.
    Show child attributesHide child attributes2

    • namestring
      The name for the note_attribute.
    • valuestring
      The value for the associated note_attribute.
  • phonestring
    The phone number associated with the address.
  • presentment_currencystringSCI
    Presentment currency is the currency used to display prices to the associated on a storefront and at checkout.
    Only set if the currency is different from the store-level currency. Else, will default to store-level currency.
  • provincestring
    The state or province associated with the address.
  • shipping_lines_overridearray of objects
    Used when shipping rates need to be overridden. If this parameter has value null, rates will be fetched when a related Charge is created or regenerated
    Show child attributesHide child attributes3

    • codestring
      The code of the associated shipping line.
    • pricestring
      The price (in store’s currency) of the associated shipping line.
    • titlestring
      The title of the associated shipping line.
  • zipstring
    The zip or postal code associated with the address.
  • cart_attributesarray
    Additional information added to an initial order.
    Important: This field will be deprecated. Please use note_attributes instead.
  • created_atdatetime
    The date and time when the address was created.
  • original_shipping_lines
    Shipping line details.
    Important: This field will be deprecated. Please use shipping_lines_override instead.
  • updated_atdatetime
    The date and time when the Address was last updated.
• buyer_accepts_marketingboolean
  Serves as the audit trail for a buyer email marketing's communication opt-in
• currencystring
  The presentment currency of the Checkout.
  Only currencies set up in the store setting store_presentment_currencies are accepted. This will also be the currency of the resulting Address and Subscriptions created by the checkout processing.
• discount_codestring
  Discount code to be used on the checkout, e.g. “DISCOUNT20”.
• emailstring
  Email address for the customer.
  will be required before being able to process a Checkout.
• external_checkout_idstring
  Cart token from ecommerce platform.
• external_checkout_sourcestring
  Ecommerce platform hosting the cart.
  Possible values

  big_commerceheadlessshopify
• external_checkout_customer_idstring
  Ecommerce platform hosting the cart.
• line_itemsarray of objectsRequired
  The details of the different items being purchased by the user.
  will be required before being able to process a Checkout.
  Show child attributesHide child attributes26

  • charge_interval_frequencyinteger
    frequency at which the user will pay for his subscription on the item.
  • cutoff_day_of_monthinteger
    Day of the month a customer should be charged. Used only if the user is to be charged on a specific day.
    Only valid if the order_interval_unit is month
  • cutoff_day_of_weekinteger
    Day of the week a customer should be charged. Used only if the user is to be charged on a specific day.
    Only valid if the order_interval_unit is week
  • expire_after_specific_number_of_chargesinteger
    Number of charges to be processed for the resulting subscription until it expires.
    Used if the user subscription on the item should stop after a few iterations. Frequently used for gift subscriptions. e.g. you offer a 3-month flower subscription to a loved one you can setup expire_after_specific_number_of_charges to 3 and a monthly frequency.
  • first_recurring_charge_delayinteger
    Add a delay (in days) to the first recurring transaction on the subscription.
    This number will get added to the already projected next charge date. e.g. if you create a monthly subscription and set the first_recurring_charge_delay to 7, the next transaction for that subscription will be 1months and 7 days post checkout.
  • fulfillment_servicestring
    Name of fulfillment service.
  • gramsinteger
    Weight in grams of the item.
    Only valid for physical items.
  • imagestring
    Image link of the item which shows on the checkout.
  • order_day_of_monthinteger
    Specify if the order should be processed on a specific day of the month.
    Only valid if the order_interval_unit is month.
  • order_day_of_weekinteger
    Specify if the order should be processed on a specific day of the week.
    Only valid if the order_interval_unit is week.
  • order_interval_frequencyinteger
    Frequency at which the user will receive orders for the subscription.
  • order_interval_unitstring
    Unit scale for the frequency of orders and charges.
    Possible values

    dayweekmonth
  • original_pricestring
    Original price of the item.
    e.g. this number will be different from the price if you offer a subscribe&save option and this line_item is for a subscription to the product.
  • pricestring
    Price charged for the item at checkout.
  • product_idinteger
    Product identifier in Recharge.
  • product_typestring
    Category of the product defined in PIM.
  • propertiesarray of objects
    An array of Property object containing customer information for an item that has been added to the checkout.
    Show child attributesHide child attributes2

    • namestring
      The name of the property.
    • valuestring
      The url reference for the image (CDN or other).
  • quantityinteger
    The number of units of the product that is purchased.
  • requires_shippingboolean
    Marks if an item needs to be packed and delivered.
  • skustring
    A unique identifier of the item in the fulfillment. Stands for Stock Keeping Unit.
  • tax_codestring
    Tax category of the product.
  • taxableboolean
    Whether tax applies to the product.
  • titlestring
    The title of the product.
  • typestring
    The type of the item.
    Possible values

    SUBSCRIPTIONONETIME
  • variant_idinteger
    Id of the product variant.
  • variant_titlestring
    The title of the product variant.
• notestring
  Note used to store free text notes.
• note_attributesarray of objects
  Structured note attributes.
  Show child attributesHide child attributes2

  • namestring
    The name for the note_attribute.
  • valuestring
    The value for the associated note_attribute.
• phonestring
  Customer phone number.
• shipping_addressobject
  Shipping address for the checkout.
  will be required before being able to process a Checkout.
  Show child attributesHide child attributes22

  • idinteger
    Unique numeric identifier for the Address.
  • address1string
    The street associated with the Address.
  • address2string
    Any additional information associated with the shipping address.
  • cart_notestringBigCommerceCustomRCS
    The note that that will be passed to the note field of Orders made within the Address.
    cart_note is not currently honored when sent to the Shopify contract api (SCI).
  • citystring
    The city associated with the shipping address.
  • companystring
    The company associated with the shipping address.
  • countrystring
    The country associated with the shipping address.
  • country_codestring
    The 2-letter country code.
  • customer_idinteger
    Unique numeric identifier for the Customer associated with the Address.
  • discount_idinteger
    Unique numeric identifier of Discount that is applied on the Address.
  • first_namestring
    The customer’s first name associated with the address.
  • last_namestring
    The customer’s last name associated with the address.
  • note_attributesarray of objects
    Extra information that is added to the order.
    Show child attributesHide child attributes2

    • namestring
      The name for the note_attribute.
    • valuestring
      The value for the associated note_attribute.
  • phonestring
    The phone number associated with the address.
  • presentment_currencystringSCI
    Presentment currency is the currency used to display prices to the associated on a storefront and at checkout.
    Only set if the currency is different from the store-level currency. Else, will default to store-level currency.
  • provincestring
    The state or province associated with the address.
  • shipping_lines_overridearray of objects
    Used when shipping rates need to be overridden. If this parameter has value null, rates will be fetched when a related Charge is created or regenerated
    Show child attributesHide child attributes3

    • codestring
      The code of the associated shipping line.
    • pricestring
      The price (in store’s currency) of the associated shipping line.
    • titlestring
      The title of the associated shipping line.
  • zipstring
    The zip or postal code associated with the address.
  • cart_attributesarray
    Additional information added to an initial order.
    Important: This field will be deprecated. Please use note_attributes instead.
  • created_atdatetime
    The date and time when the address was created.
  • original_shipping_lines
    Shipping line details.
    Important: This field will be deprecated. Please use shipping_lines_override instead.
  • updated_atdatetime
    The date and time when the Address was last updated.

Response attributes

• errorsobject

#Retrieve a checkout

#Update a checkout

Body parameters

• analytics_dataobject
  Analytics data containing amongst other things the utm_params.
  analytics_data will be added to Subscription, Customer and Charge objects created as a result of the successful processing of the Checkout.
  Show child attributesHide child attributes1

  • utm_paramsarray of objects
    An array containing utm_parameters which are commonly used to store the details of an acquisition campaign.
    Show child attributesHide child attributes7

    • utm_campaignstring
      The utm campaign details.
    • utm_contentstring
      The utm content.
    • utm_data_sourcestring
      The source of the campaign parameter.
    • utm_sourcestring
      The utm source.
    • utm_mediumstring
      The utm medium.
    • utm_termstring
      The utm term.
    • utm_timestampstring
      The utm timestamp.
• billing_addressobject
  Billing address for the checkout.
  Show child attributesHide child attributes22

  • idinteger
    Unique numeric identifier for the Address.
  • address1string
    The street associated with the Address.
  • address2string
    Any additional information associated with the shipping address.
  • cart_notestringBigCommerceCustomRCS
    The note that that will be passed to the note field of Orders made within the Address.
    cart_note is not currently honored when sent to the Shopify contract api (SCI).
  • citystring
    The city associated with the shipping address.
  • companystring
    The company associated with the shipping address.
  • countrystring
    The country associated with the shipping address.
  • country_codestring
    The 2-letter country code.
  • customer_idinteger
    Unique numeric identifier for the Customer associated with the Address.
  • discount_idinteger
    Unique numeric identifier of Discount that is applied on the Address.
  • first_namestring
    The customer’s first name associated with the address.
  • last_namestring
    The customer’s last name associated with the address.
  • note_attributesarray of objects
    Extra information that is added to the order.
    Show child attributesHide child attributes2

    • namestring
      The name for the note_attribute.
    • valuestring
      The value for the associated note_attribute.
  • phonestring
    The phone number associated with the address.
  • presentment_currencystringSCI
    Presentment currency is the currency used to display prices to the associated on a storefront and at checkout.
    Only set if the currency is different from the store-level currency. Else, will default to store-level currency.
  • provincestring
    The state or province associated with the address.
  • shipping_lines_overridearray of objects
    Used when shipping rates need to be overridden. If this parameter has value null, rates will be fetched when a related Charge is created or regenerated
    Show child attributesHide child attributes3

    • codestring
      The code of the associated shipping line.
    • pricestring
      The price (in store’s currency) of the associated shipping line.
    • titlestring
      The title of the associated shipping line.
  • zipstring
    The zip or postal code associated with the address.
  • cart_attributesarray
    Additional information added to an initial order.
    Important: This field will be deprecated. Please use note_attributes instead.
  • created_atdatetime
    The date and time when the address was created.
  • original_shipping_lines
    Shipping line details.
    Important: This field will be deprecated. Please use shipping_lines_override instead.
  • updated_atdatetime
    The date and time when the Address was last updated.
• buyer_accepts_marketingboolean
  Does the buyer accept marketing, newsletters etc.
• currencystring
  The presentment currency of the Checkout.
  Only currencies set up in the store setting store_presentment_currencies are accepted. This will also be the currency of the resulting Address and Subscriptions created by the checkout processing.
• discount_codestring
  Discount code to be used on the checkout, e.g. “DISCOUNT20”.
• emailstring
  Email address for the customer.
• external_checkout_idstring
  Cart token from ecommerce platform.
• external_checkout_sourcestring
  Ecommerce platform hosting the cart.
  Possible values

  big_commerceheadlessshopify
• external_checkout_customer_idstring
  Ecommerce platform hosting the cart.
• line_itemsarray of objects
  quantity, product_id and variant_id are required parameters in line_items.
  Show child attributesHide child attributes26

  • charge_interval_frequencyinteger
    frequency at which the user will pay for his subscription on the item.
  • cutoff_day_of_monthinteger
    Day of the month a customer should be charged. Used only if the user is to be charged on a specific day.
    Only valid if the order_interval_unit is month
  • cutoff_day_of_weekinteger
    Day of the week a customer should be charged. Used only if the user is to be charged on a specific day.
    Only valid if the order_interval_unit is week
  • expire_after_specific_number_of_chargesinteger
    Number of charges to be processed for the resulting subscription until it expires.
    Used if the user subscription on the item should stop after a few iterations. Frequently used for gift subscriptions. e.g. you offer a 3-month flower subscription to a loved one you can setup expire_after_specific_number_of_charges to 3 and a monthly frequency.
  • first_recurring_charge_delayinteger
    Add a delay (in days) to the first recurring transaction on the subscription.
    This number will get added to the already projected next charge date. e.g. if you create a monthly subscription and set the first_recurring_charge_delay to 7, the next transaction for that subscription will be 1months and 7 days post checkout.
  • fulfillment_servicestring
    Name of fulfillment service.
  • gramsinteger
    Weight in grams of the item.
    Only valid for physical items.
  • imagestring
    Image link of the item which shows on the checkout.
  • order_day_of_monthinteger
    Specify if the order should be processed on a specific day of the month.
    Only valid if the order_interval_unit is month.
  • order_day_of_weekinteger
    Specify if the order should be processed on a specific day of the week.
    Only valid if the order_interval_unit is week.
  • order_interval_frequencyinteger
    Frequency at which the user will receive orders for the subscription.
  • order_interval_unitstring
    Unit scale for the frequency of orders and charges.
    Possible values

    dayweekmonth
  • original_pricestring
    Original price of the item.
    e.g. this number will be different from the price if you offer a subscribe&save option and this line_item is for a subscription to the product.
  • pricestring
    Price charged for the item at checkout.
  • product_idinteger
    Product identifier in Recharge.
  • product_typestring
    Category of the product defined in PIM.
  • propertiesarray of objects
    An array of Property object containing customer information for an item that has been added to the checkout.
    Show child attributesHide child attributes2

    • namestring
      The name of the property.
    • valuestring
      The url reference for the image (CDN or other).
  • quantityinteger
    The number of units of the product that is purchased.
  • requires_shippingboolean
    Marks if an item needs to be packed and delivered.
  • skustring
    A unique identifier of the item in the fulfillment. Stands for Stock Keeping Unit.
  • tax_codestring
    Tax category of the product.
  • taxableboolean
    Whether tax applies to the product.
  • titlestring
    The title of the product.
  • typestring
    The type of the item.
    Possible values

    SUBSCRIPTIONONETIME
  • variant_idinteger
    Id of the product variant.
  • variant_titlestring
    The title of the product variant.
• notestring
  Note attribute used to store custom notes.
• note_attributesarray of objects
  Each array entry must contain a dictionary with “name” and “value” keys.
  Show child attributesHide child attributes2

  • namestring
    The name for the note_attribute.
  • valuestring
    The value for the associated note_attribute.
• partial_shippingboolean
  When set to true, shipping address validations are reduced to only require country and zip when creating/updating a checkout. The full shipping address including address line 1 must be added to the checkout before processing associated charges. This is helpful for mobile payments.
  
  Related guides: Mobile payments
• phonestring
  Customer phone number.
• shipping_addressobject
  Shipping address for the checkout.
  When using mobile payment options, insufficient shipping address data is available until payment intent, which causes validation errors when updating the checkout object.
  
  Related guides: Checkout mobile payment
  Show child attributesHide child attributes22

  • idinteger
    Unique numeric identifier for the Address.
  • address1string
    The street associated with the Address.
  • address2string
    Any additional information associated with the shipping address.
  • cart_notestringBigCommerceCustomRCS
    The note that that will be passed to the note field of Orders made within the Address.
    cart_note is not currently honored when sent to the Shopify contract api (SCI).
  • citystring
    The city associated with the shipping address.
  • companystring
    The company associated with the shipping address.
  • countrystring
    The country associated with the shipping address.
  • country_codestring
    The 2-letter country code.
  • customer_idinteger
    Unique numeric identifier for the Customer associated with the Address.
  • discount_idinteger
    Unique numeric identifier of Discount that is applied on the Address.
  • first_namestring
    The customer’s first name associated with the address.
  • last_namestring
    The customer’s last name associated with the address.
  • note_attributesarray of objects
    Extra information that is added to the order.
    Show child attributesHide child attributes2

    • namestring
      The name for the note_attribute.
    • valuestring
      The value for the associated note_attribute.
  • phonestring
    The phone number associated with the address.
  • presentment_currencystringSCI
    Presentment currency is the currency used to display prices to the associated on a storefront and at checkout.
    Only set if the currency is different from the store-level currency. Else, will default to store-level currency.
  • provincestring
    The state or province associated with the address.
  • shipping_lines_overridearray of objects
    Used when shipping rates need to be overridden. If this parameter has value null, rates will be fetched when a related Charge is created or regenerated
    Show child attributesHide child attributes3

    • codestring
      The code of the associated shipping line.
    • pricestring
      The price (in store’s currency) of the associated shipping line.
    • titlestring
      The title of the associated shipping line.
  • zipstring
    The zip or postal code associated with the address.
  • cart_attributesarray
    Additional information added to an initial order.
    Important: This field will be deprecated. Please use note_attributes instead.
  • created_atdatetime
    The date and time when the address was created.
  • original_shipping_lines
    Shipping line details.
    Important: This field will be deprecated. Please use shipping_lines_override instead.
  • updated_atdatetime
    The date and time when the Address was last updated.

#Retrieve shipping rates

Response attributes

• checkoutobject
  Relevant checkout details for Shipping rates availability.
  Show child attributesHide child attributes3

  • subtotal_pricestring
    Price excluding shipping and tax, including discounts.
  • total_pricestring
    Total price including tax and shipping cost for that particular shipping rate.
  • total_taxstring
    Total tax value for the checkout.
• codestring
  Code given to the shipping rate entry.
• delivery_rangestring
• descriptionstring
  Long form version of the title to provide details on the shipping rate.
• handlestring
  Unique identifier for the shipping rate.
• namestring
  Name of the shipping rate.
• phone_requiredboolean
  Specifies if a phone number must be required if this shipping rate is selected by the user.
• pricestring
  Price of the shipping rate.
• tax_linesobject
  Tax lines associated with the shipping rate if tax is being charged on shipping.
• titlestring
  Title of the shipping rate.

#Process a checkout

Body parameters

• payment_processorstringRequired
  The name of payment processor.
  Possible values

  stripebraintreemollieauthorize
• payment_tokenstringRequired
  Payment token that will be used in transaction.
  For stripe this field needs to be populated with a payment method.
  For braintree this field needs to be populated with a payment nonce.
  For mollie this field needs to be populated with a mandate.
• payment_typestring
  It identifies the payment type.
  Possible values

  CREDIT_CARDPAYPALAPPLE_PAYGOOGLE_PAY

Response attributes

• authorization_tokenstring
  Unique identifier for the authorization of the charge.
• charge_idstring
  Unique identifier for the charge resulting from the processing of the checkout.
• freeboolean
  Boolean to identify if the checkout was free.
• payment_processorstring
  Payment processor used for the checkout.
• payment_processor_customer_idstring
  Unique identifier for the customer created in the payment service provider platform (aka PSP).
• payment_processor_transaction_idstring
  Unique identifier for the transaction created in the payment service provider platform (aka PSP).
• payment_tokenstring
  Token used for the checkout which will be reused for future transaction processing unless replaced.
• payment_typestring
  Payment type used for the checkout.
• statusstring
  Status of the checkout