Documentation

Fields

• purchaseCreateAccount :: AccountPurchase

  account

• purchaseCreateBilling_info_id :: Maybe Text

  billing_info_id: The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info. `billing_info_id` can ONLY be used for sites utilizing the Wallet feature.

• purchaseCreateBusiness_entity_code :: Maybe Text

  business_entity_code: The `business_entity_code` is the value that represents a specific business entity for an end customer. When `business_entity_code` is used to assign a business entity to the subscription, all future billing events for the subscription will bill to the specified business entity. Available when the `Multiple Business Entities` feature is enabled. If both `business_entity_id` and `business_entity_code` are present, `business_entity_id` will be used.

• purchaseCreateBusiness_entity_id :: Maybe Text

  business_entity_id: The `business_entity_id` is the value that represents a specific business entity for an end customer. When `business_entity_id` is used to assign a business entity to the subscription, all future billing events for the subscription will bill to the specified business entity. Available when the `Multiple Business Entities` feature is enabled. If both `business_entity_id` and `business_entity_code` are present, `business_entity_id` will be used.

• purchaseCreateCollection_method :: Maybe PurchaseCreateCollection_method

  collection_method: Must be set to manual in order to preview a purchase for an Account that does not have payment information associated with the Billing Info.

• purchaseCreateCoupon_codes :: Maybe [Text]

  coupon_codes: A list of coupon_codes to be redeemed on the subscription or account during the purchase.

• purchaseCreateCredit_customer_notes :: Maybe Text

  credit_customer_notes: Notes to be put on the credit invoice resulting from credits in the purchase, if any.

• purchaseCreateCurrency :: Text

  currency: 3-letter ISO 4217 currency code.

  Constraints:

  • Maximum length of 3
• purchaseCreateCustomer_notes :: Maybe Text

  customer_notes

• purchaseCreateGateway_code :: Maybe Text

  gateway_code: The default payment gateway identifier to be used for the purchase transaction. This will also be applied as the default for any subscriptions included in the purchase request.

  Constraints:

  • Maximum length of 13
• purchaseCreateGift_card_redemption_code :: Maybe Text

  gift_card_redemption_code: A gift card redemption code to be redeemed on the purchase invoice.

• purchaseCreateLine_items :: Maybe [LineItemCreate]

  line_items: A list of one time charges or credits to be created with the purchase.

• purchaseCreateNet_terms :: Maybe Int

  net_terms: Integer paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. For `manual` collection method, an additional 24 hours is added to ensure the customer has the entire last day to make payment before becoming past due. For example:

  If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created. If an invoice is due `net 30`, it will become past due at 31 days exactly. If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.

  For `automatic` collection method, the additional 24 hours is not added. For example, On-Receipt is due immediately, and `net 30` will become due exactly 30 days from invoice generation, at which point Recurly will attempt collection. When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`.

  For more information on how net terms work with `manual` collection visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms) or visit (https://docs.recurly.com/docs/automatic-invoicing-terms#section-collection-terms) for information about net terms using `automatic` collection.

  Constraints:

  • Minimum of 0.0
• purchaseCreateNet_terms_type :: Maybe PurchaseCreateNet_terms_type

  net_terms_type: Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month.

• purchaseCreatePo_number :: Maybe Text

  po_number: For manual invoicing, this identifies the PO number associated with the subscription.

  Constraints:

  • Maximum length of 50
• purchaseCreateShipping :: Maybe PurchaseCreateShipping

  shipping

• purchaseCreateSubscriptions :: Maybe [SubscriptionPurchase]

  subscriptions: A list of subscriptions to be created with the purchase.

• purchaseCreateTerms_and_conditions :: Maybe Text

  terms_and_conditions: Terms and conditions to be put on the purchase invoice.

• purchaseCreateTransaction_type :: Maybe PurchaseCreateTransaction_type

  transaction_type: An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.

• purchaseCreateVat_reverse_charge_notes :: Maybe Text

  vat_reverse_charge_notes: VAT reverse charge notes for cross border European tax settlement.

Fields

• purchaseCreateShippingAddress :: Maybe ShippingAddressCreate

  address

• purchaseCreateShippingAddress_id :: Maybe Text

  address_id: Assign a shipping address from the account's existing shipping addresses. If this and `address` are both present, `address` will take precedence.

  Constraints:

  • Maximum length of 13
• purchaseCreateShippingFees :: Maybe [ShippingFeeCreate]

  fees: A list of shipping fees to be created as charges with the purchase.