Recurly · Schema
PurchaseCreate
A purchase is only a request data type and is not persistent in Recurly, an InvoiceCollection will be the returned type.
SubscriptionBillingPaymentsRecurring RevenueInvoicingDunningRevenue RecognitionChurnMCPShopifyWebhook
Properties
| Name | Type | Description |
|---|---|---|
| currency | string | 3-letter ISO 4217 currency code. |
| account | object | |
| billing_info_id | string | 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 |
| business_entity_id | string | 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 bill |
| business_entity_code | string | 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 |
| collection_method | object | 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. |
| po_number | string | For manual invoicing, this identifies the PO number associated with the subscription. |
| net_terms | integer | 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) tha |
| net_terms_type | object | |
| credit_application_policy_override | object | |
| terms_and_conditions | string | Terms and conditions to be put on the purchase invoice. |
| transaction | object | (Transaction Data, Card on File) - Options for flagging transactions as Customer or Merchant Initiated Unscheduled. |
| customer_notes | string | |
| vat_reverse_charge_notes | string | VAT reverse charge notes for cross border European tax settlement. |
| vertex_transaction_type | object | |
| credit_customer_notes | string | Notes to be put on the credit invoice resulting from credits in the purchase, if any. |
| gateway_code | string | 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. |
| shipping | object | |
| line_items | array | A list of one time charges or credits to be created with the purchase. |
| subscriptions | array | A list of subscriptions to be created with the purchase. |
| coupon_codes | array | A list of coupon_codes to be redeemed on the subscription or account during the purchase. |
| gift_card_redemption_code | string | A gift card redemption code to be redeemed on the purchase invoice. |
| transaction_type | object | 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. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/recurly/json-schema/recurly-purchase-create-schema.json",
"title": "PurchaseCreate",
"description": "A purchase is only a request data type and is not persistent in Recurly, an InvoiceCollection will be the returned type.",
"x-generated": "2026-11-05",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/recurly-openapi.yml#/components/schemas/PurchaseCreate",
"type": "object",
"properties": {
"currency": {
"type": "string",
"title": "Currency",
"description": "3-letter ISO 4217 currency code.",
"maxLength": 3
},
"account": {
"$ref": "#/$defs/AccountPurchase"
},
"billing_info_id": {
"type": "string",
"description": "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."
},
"business_entity_id": {
"type": "string",
"title": "Business Entity ID",
"description": "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."
},
"business_entity_code": {
"type": "string",
"title": "Business Entity Code",
"description": "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."
},
"collection_method": {
"title": "Collection method",
"description": "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.",
"default": "automatic",
"$ref": "#/$defs/CollectionMethodEnum"
},
"po_number": {
"type": "string",
"title": "Purchase order number",
"description": "For manual invoicing, this identifies the PO number associated with the subscription.",
"maxLength": 50
},
"net_terms": {
"type": "integer",
"title": "Net terms",
"description": "Integer paired with `Net Terms Type` and representing the number\nof days past the current date (for `net` Net Terms Type) or days after\nthe last day of the current month (for `eom` Net Terms Type) that the\ninvoice will become past due. For `manual` collection method, an additional 24 hours is\nadded to ensure the customer has the entire last day to make payment before\nbecoming past due. For example:\n\nIf an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created.\nIf an invoice is due `net 30`, it will become past due at 31 days exactly.\nIf an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.\n\nFor `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.\nWhen `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`.\n\nFor more information on how net terms work with `manual` collection visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)\nor visit (https://docs.recurly.com/docs/automatic-invoicing-terms#section-collection-terms) for information about net terms using `automatic` collection.",
"minimum": 0,
"default": 0
},
"net_terms_type": {
"$ref": "#/$defs/NetTermsTypeEnum"
},
"credit_application_policy_override": {
"$ref": "#/$defs/CreditApplicationPolicy"
},
"terms_and_conditions": {
"type": "string",
"title": "Terms and conditions",
"description": "Terms and conditions to be put on the purchase invoice."
},
"transaction": {
"type": "object",
"description": "(Transaction Data, Card on File) - Options for flagging transactions as Customer or Merchant Initiated Unscheduled.",
"allOf": [
{
"type": "object",
"properties": {
"initiator": {
"$ref": "#/$defs/initiator"
},
"merchant_reason_code": {
"$ref": "#/$defs/merchant_reason_code"
},
"skip_gateway_fraud": {
"type": "boolean",
"title": "Skip Gateway Fraud",
"description": "When set to `true`, instructs the payment gateway to skip fraud checks for this transaction. This is useful for recurring transactions where fraud checks have already been performed on the initial transaction. Note that not all gateways support this feature. For Stripe, this skips Radar fraud rules; for Adyen, this skips"
},
"skip_recurly_fraud": {
"type": "boolean",
"title": "Skip Recurly Fraud",
"description": "When set to `true`, skips Recurly's fraud detection checks for this transaction, including Kount and IP-based fraud screening. Does not affect gateway-level fraud checks. Use `skip_all_fraud` to skip all fraud checks."
},
"skip_all_fraud": {
"type": "boolean",
"title": "Skip All Fraud",
"description": "When set to `true`, skips all fraud checks for this transaction, including both gateway-level fraud checks and Recurly's fraud detection services. This is useful for trusted transactions where fraud screening is not required."
},
"descriptor_suffix": {
"type": "string",
"title": "Transaction Descriptor Suffix",
"maxLength": 255,
"description": "Optionally overrides the suffix component of the composed transaction descriptor. If omitted, the suffix is derived from the subscription's plan name or the invoice description, with a Trial prefix on Visa trial conversions. Subject to gateway availability and payment method support."
}
}
}
]
},
"customer_notes": {
"type": "string",
"title": "Customer notes"
},
"vat_reverse_charge_notes": {
"type": "string",
"title": "VAT reverse charge notes",
"description": "VAT reverse charge notes for cross border European tax settlement."
},
"vertex_transaction_type": {
"$ref": "#/$defs/VertexTransactionTypeEnum"
},
"credit_customer_notes": {
"type": "string",
"title": "Credit customer notes",
"description": "Notes to be put on the credit invoice resulting from credits in the purchase, if any."
},
"gateway_code": {
"type": "string",
"title": "Gateway Code",
"description": "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.",
"maxLength": 13
},
"shipping": {
"type": "object",
"x-class-name": "ShippingPurchase",
"properties": {
"address_id": {
"type": "string",
"title": "Shipping address ID",
"description": "Assign a shipping address from the account's existing shipping addresses. If this and `address` are both present, `address` will take precedence.",
"maxLength": 13
},
"address": {
"$ref": "#/$defs/ShippingAddressCreate"
},
"fees": {
"type": "array",
"title": "Shipping fees",
"description": "A list of shipping fees to be created as charges with the purchase.",
"items": {
"$ref": "#/$defs/ShippingFeeCreate"
}
}
}
},
"line_items": {
"type": "array",
"title": "Line items",
"description": "A list of one time charges or credits to be created with the purchase.",
"items": {
"$ref": "#/$defs/LineItemCreate"
}
},
"subscriptions": {
"type": "array",
"title": "Subscriptions",
"description": "A list of subscriptions to be created with the purchase.",
"items": {
"$ref": "#/$defs/SubscriptionPurchase"
}
},
"coupon_codes": {
"type": "array",
"title": "Coupon codes",
"description": "A list of coupon_codes to be redeemed on the subscription or account during the purchase.",
"items": {
"type": "string"
}
},
"gift_card_redemption_code": {
"type": "string",
"title": "Gift card redemption code",
"description": "A gift card redemption code to be redeemed on the purchase invoice."
},
"transaction_type": {
"description": "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.",
"$ref": "#/$defs/GatewayTransactionTypeEnum"
}
},
"required": [
"currency",
"account"
],
"$defs": {
"AccountAcquisitionUpdate": {
"type": "object",
"properties": {
"cost": {
"type": "object",
"x-class-name": "AccountAcquisitionCost",
"title": "Account balance",
"items": {
"type": "object"
},
"properties": {
"currency": {
"type": "string",
"title": "Currency",
"description": "3-letter ISO 4217 currency code.",
"maxLength": 3
},
"amount": {
"type": "number",
"format": "float",
"title": "Amount",
"description": "The amount of the corresponding currency used to acquire the account."
}
}
},
"channel": {
"description": "The channel through which the account was acquired.",
"$ref": "#/$defs/ChannelEnum"
},
"subchannel": {
"type": "string",
"description": "An arbitrary subchannel string representing a distinction/subcategory within a broader channel."
},
"campaign": {
"type": "string",
"description": "An arbitrary identifier for the marketing campaign that led to the acquisition of this account."
},
"acquired_at": {
"type": "string",
"format": "date-time",
"description": "Date the account was first created if different than the account.created_at. ie Importing accounts."
}
}
},
"AccountPurchase": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Optional, but if present allows an existing account to be used and updated as part of the purchase.",
"maxLength": 13
},
"code": {
"type": "string",
"description": "The unique identifier of the account. This cannot be changed once the account is created.",
"maxLength": 50
},
"acquisition": {
"$ref": "#/$defs/AccountAcquisitionUpdate"
}
},
"required": [
"code"
]
},
{
"$ref": "#/$defs/AccountUpdate"
}
]
},
"AccountUpdate": {
"type": "object",
"properties": {
"username": {
"type": "string",
"description": "A secondary value for the account.",
"maxLength": 255
},
"email": {
"type": "string",
"format": "email",
"description": "The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.",
"maxLength": 255
},
"preferred_locale": {
"description": "Used to determine the language and locale of emails sent on behalf of the merchant to the customer. The list of locales is restricted to those the merchant has enabled on the site.",
"$ref": "#/$defs/PreferredLocaleEnum"
},
"preferred_time_zone": {
"type": "string",
"description": "Used to determine the time zone of emails sent on behalf of the merchant to the customer. Must be a [supported IANA time zone name](https://docs.recurly.com/docs/email-time-zones-and-time-stamps#supported-api-iana-time-zone-names)"
},
"cc_emails": {
"type": "string",
"description": "Additional email address that should receive account correspondence. These should be separated only by commas. These CC emails will receive all emails that the `email` field also receives.",
"maxLength": 255
},
"first_name": {
"type": "string",
"maxLength": 255
},
"last_name": {
"type": "string",
"maxLength": 255
},
"company": {
"type": "string",
"maxLength": 100
},
"vat_number": {
"type": "string",
"description": "The VAT number of the account (to avoid having the VAT applied). This is only used for manually collected invoices.",
"maxLength": 20
},
"tax_exempt": {
"type": "boolean",
"description": "The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account."
},
"exemption_certificate": {
"type": "string",
"description": "The tax exemption certificate number for the account. If the merchant has an integration for the Vertex tax provider, this optional value will be sent in any tax calculation requests for the account.",
"maxLength": 30
},
"override_business_entity_id": {
"type": "string",
"title": "Override Business Entity ID",
"description": "Unique ID to identify the business entity assigned to the account. Available when the `Multiple Business Entities` feature is enabled."
},
"parent_account_code": {
"type": "string",
"maxLength": 50,
"description": "The account code of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account."
},
"parent_account_id": {
"type": "string",
"maxLength": 13,
"description": "The UUID of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account."
},
"bill_to": {
"maxLength": 6,
"description": "An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.",
"$ref": "#/$defs/BillToEnum"
},
"transaction_type": {
"description": "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.",
"$ref": "#/$defs/GatewayTransactionTypeEnum"
},
"dunning_campaign_id": {
"type": "string",
"title": "Dunning Campaign ID",
"description": "Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used."
},
"invoice_template_id": {
"type": "string",
"title": "Invoice Template ID",
"description": "Unique ID to identify an invoice template. Available when the site is on a Pro or Elite plan. Used to specify which invoice template, if any, should be used to generate invoices for the account."
},
"address": {
"$ref": "#/$defs/Address"
},
"billing_info": {
"$ref": "#/$defs/BillingInfoCreate"
},
"custom_fields": {
"$ref": "#/$defs/CustomFields"
},
"entity_use_code": {
"type": "string",
"description": "The Avalara AvaTax value that can be passed to identify the customer type for tax purposes. The range of values can be A - R (more info at Avalara). Value is case-sensitive."
},
"bill_date": {
"type": "string",
"title": "Bill Date",
"format": "date-time",
"description": "The preferred billing date for the account. This date will be used as the billing date for when activating new subscriptions on the account."
}
}
},
"AchAccountTypeEnum": {
"type": "string",
"description": "The bank account type. (ACH only)",
"enum": [
"checking",
"savings"
]
},
"AchTypeEnum": {
"type": "string",
"description": "The payment method type for a non-credit card based billing info. `bacs`, `becs`, `pix-automatico`, `mercadopago`, `upi-autopay` are the only accepted values.",
"enum": [
"bacs",
"becs",
"pix-automatico",
"mercadopago",
"upi-autopay"
]
},
"AddOnSourceEnum": {
"type": "string",
"title": "Add-on source",
"description": "Used to determine where the associated add-on data is pulled from. If this value is set to\n`plan_add_on` or left blank, then add-on data will be pulled from the plan's add-ons. If the associated\n`plan` has `allow_any_item_on_subscriptions` set to `true` and this field is set to `item`, then\nthe associated add-on data will be pulled from the site's item catalog.\n",
"default": "plan_add_on",
"enum": [
"plan_add_on",
"item"
]
},
"Address": {
"type": "object",
"properties": {
"phone": {
"type": "string",
"title": "Phone number"
},
"street1": {
"type": "string",
"title": "Street 1",
"maxLength": 50
},
"street2": {
"type": "string",
"title": "Street 2",
"maxLength": 50
},
"city": {
"type": "string",
"title": "City"
},
"region": {
"type": "string",
"title": "State/Province",
"description": "State or province."
},
"postal_code": {
"type": "string",
"title": "Zip/Postal code",
"description": "Zip or postal code."
},
"country": {
"type": "string",
"title": "Country",
"description": "Country, 2-letter ISO 3166-1 alpha-2 code."
},
"geo_code": {
"type": "string",
"maxLength": 20,
"description": "Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled."
}
}
},
"BillToEnum": {
"type": "string",
"enum": [
"parent",
"self"
]
},
"BillingInfoCreate": {
"type": "object",
"properties": {
"token_id": {
"type": "string",
"title": "Token ID",
"description": "A token [generated by Recurly.js](https://recurly.com/developers/reference/recurly-js/#getting-a-token).",
"maxLength": 22
},
"first_name": {
"type": "string",
"title": "First name",
"maxLength": 50
},
"last_name": {
"type": "string",
"title": "Last name",
"maxLength": 50
},
"company": {
"type": "string",
"title": "Company name",
"maxLength": 100
},
"address": {
"$ref": "#/$defs/Address"
},
"number": {
"type": "string",
"title": "Credit card number",
"description": "Credit card number, spaces and dashes are accepted."
},
"month": {
"type": "string",
"title": "Expiration month",
"maxLength": 2
},
"year": {
"type": "string",
"title": "Expiration year",
"maxLength": 4
},
"cvv": {
"type": "string",
"title": "Security code or CVV",
"description": "*STRONGLY RECOMMENDED*",
"maxLength": 4
},
"currency": {
"type": "string",
"description": "3-letter ISO 4217 currency code."
},
"vat_number": {
"type": "string",
"title": "VAT number"
},
"ip_address": {
"type": "string",
"title": "IP address",
"description": "*STRONGLY RECOMMENDED* Customer's IP address when updating their billing information.",
"maxLength": 20
},
"gateway_token": {
"type": "string",
"title": "A token used in place of a credit card in order to perform transactions. Must be used in conjunction with `gateway_code`.",
"maxLength": 50
},
"gateway_code": {
"type": "string",
"title": "An identifier for a specific payment gateway.",
"maxLength": 12
},
"backup_gateway_code": {
"type": "string",
"title": "Identifies a backup gateway. Applies only when `gateway_code` is provided and that gateway is in failover. Providing this code overrides gateway exclusion configurations and restricts the backup to this gateway.",
"maxLength": 12
},
"payment_gateway_references": {
"type": "array",
"description": "Array of Payment Gateway References, each a reference to a third-party gateway object of varying types.",
"items": {
"$ref": "#/$defs/PaymentGatewayReferences"
},
"properties": {
"token": {
"type": "string",
"maxLength": 50
},
"reference_type": {
"type": "string",
"$ref": "#/$defs/PaymentGatewayReferencesEnum"
}
}
},
"gateway_attributes": {
"type": "object",
"description": "Additional attributes to send to the gateway.",
"x-class-name": "GatewayAttributes",
"properties": {
"account_reference": {
"type": "string",
"description": "Used by Adyen and Braintree gateways. For Adyen the Shopper Reference value used when the external token was created. Must be used in conjunction with gateway_token and gateway_code. For Braintree the PayPal PayerID is populated in the response.",
"maxLength": 264
}
}
},
"amazon_billing_agreement_id": {
"type": "string",
"title": "Amazon billing agreement ID",
"description": "Only supported on Amazon V1. For Amazon V2, use token_id with Recurly.js."
},
"paypal_billing_agreement_id": {
"type": "string",
"title": "PayPal billing agreement ID"
},
"roku_billing_agreement_id": {
"type": "string",
"title": "Roku's CIB if billing through Roku"
},
"fraud_session_id": {
"type": "string",
"title": "Fraud Session ID"
},
"adyen_risk_profile_reference_id": {
"type": "string",
"title": "Adyen Risk Profile Reference ID",
"description": "The Adyen Risk Profile Reference ID is used to identify the risk profile for the payment method."
},
"transaction_type": {
"description": "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.",
"$ref": "#/$defs/GatewayTransactionTypeEnum"
},
"three_d_secure_action_result_token_id": {
"type": "string",
"title": "3-D Secure action result token ID",
"description": "A token generated by Recurly.js after completing a 3-D Secure device fingerprinting or authentication challenge.",
"maxLength": 22
},
"iban": {
"type": "string",
"maxLength": 34,
"description": "The International Bank Account Number, up to 34 alphanumeric characters comprising a country code; two check digits; and a number that includes the domestic bank account number, branch identifier, and potential routing information"
},
"name_on_account": {
"type": "string",
"maxLength": 255,
"description": "The name associated with the bank account (ACH, SEPA, Bacs only)"
},
"account_number": {
"type": "string",
"maxLength": 255,
"description": "The bank account number. (ACH, Bacs only)"
},
"routing_number": {
"type": "string",
"maxLength": 15,
"description": "The bank's rounting number. (ACH only)"
},
"sort_code": {
"type": "string",
"maxLength": 15,
"description": "Bank identifier code for UK based banks. Required for Bacs based billing infos. (Bacs only)"
},
"type": {
"$ref": "#/$defs/AchTypeEnum"
},
"account_type": {
"$ref": "#/$defs/AchAccountTypeEnum"
},
"tax_identifier": {
"type": "string",
"description": "Tax identifier is required if adding a billing info that is a consumer card in Brazil or in Argentina. This would be the customer's CPF/CNPJ (Brazil) and CUIT (Argentina). CPF, CNPJ and CUIT are tax identifiers for all residents who pay taxes in Brazil and Argentina respectively."
},
"tax_identifier_type": {
"description": "This field and a value of `cpf`, `cnpj` or `cuit` are required if adding a billing info that is an elo or hipercard type in Brazil or in Argentina.",
"$ref": "#/$defs/TaxIdentifierTypeEnum"
},
"primary_payment_method": {
"type": "boolean",
"title": "Primary Payment Method",
"description": "The `primary_payment_method` field is used to designate the primary billing info on the account. The first billing info created on an account will always become primary. Adding additional billing infos provides the flexibility to mark another billing info as primary, or adding additional non-primary billing infos. This can be accomplished by passing the `primary_payment_method` with a value of `true`. When adding billing infos via the billing_info and /accounts endpoints, this value is not permitted, and will return an error if provided."
},
"backup_payment_method": {
"type": "boolean",
"description": "The `backup_payment_method` field is used to designate a billing info as a backup on the account that will be tried if the initial billing info used for an invoice is declined. All payment methods, including the billing info marked `primary_payment_method` can be set as a backup. An account can have a maximum of 1 backup, if a user sets a different payment method as a backup, the existing backup will no longer be marked as such."
},
"external_hpp_type": {
"$ref": "#/$defs/ExternalHppTypeEnum"
},
"online_banking_payment_type": {
"$ref": "#/$defs/OnlineBankingPaymentTypeEnum",
"deprecated": true
},
"card_type": {
"$ref": "#/$defs/CardTypeEnum"
},
"card_network_preference": {
"description": "Represents the card network preference associated with the billing info for dual badged cards. Must be a supported card network.",
"$ref": "#/$defs/CardNetworkEnum"
},
"return_url": {
"type": "string",
"title": "Return URL",
"description": "Specifies a URL to which a consumer will be redirected upon completion of a redirect payment flow. Only redirect payment flows operating through Adyen Components will utilize this return URL."
},
"authentication_method": {
"$ref": "#/$defs/UpiAutopayAuthenticationMethodEnum"
},
"store_billing_info": {
"type": "boolean",
"description": "Whether to store this billing info onto its associated account. Defaults to `true`."
}
}
},
"CardNetworkEnum": {
"type": "string",
"enum": [
"Bancontact",
"CartesBancaires",
"Dankort",
"MasterCard",
"Visa"
]
},
"CardTypeEnum": {
"type": "string",
"enum": [
"American Express",
"Dankort",
"Diners Club",
"Discover",
"ELO",
"Forbrugsforeningen",
"Hipercard",
"JCB",
"Laser",
"Maestro",
"MasterCard",
"Test Card",
"Union Pay",
"Unknown",
"Visa",
"Tarjeta Naranja"
]
},
"ChannelEnum": {
"type": "string",
"enum": [
"advertising",
"blog",
"direct_traffic",
"email",
"events",
"marketing_content",
"organic_search",
"other",
"outbound_sales",
"paid_search",
"public_relations",
"referral",
"social_media"
]
},
"CollectionMethodEnum": {
"type": "string",
"enum": [
"automatic",
"manual"
]
},
"CreditApplicationAllowedOriginTypeEnum": {
"type": "string",
"title": "Credit Application Allowed Origin Type",
"description": "The origin type of a credit invoice that can be allowed in a credit application policy",
"enum": [
"line_item_refund",
"open_amount_refund",
"immediate_change",
"termination",
"credit",
"write_off",
"refund",
"external_refund",
"carryforward_credit",
"usage_correction",
"prepayment",
"gift_card",
"carryforward_gift_credit"
]
},
"CreditApplicationModeEnum": {
"type": "string",
"title": "Credit Application Mode",
"description": "Determines which credit invoices are applied to invoices:\n- `all`: All available credit invoices are applied (default)\n- `none`: No credit invoices are applied automatically\n",
"enum": [
"all",
"none"
],
"default": "all"
},
"CreditApplicationPolicy": {
"type": "object",
"title": "Credit Application Policy",
"description": "Controls whether credit invoices are automatically applied to new invoices.\nThe `mode` field determines the application behavior. When mode is `all`,\nthe optional `allowed_origins` array can restrict which credit invoice origins\nare applied.\n",
"properties": {
"mode": {
"$ref": "#/$defs/CreditApplicationModeEnum"
},
"allowed_origins": {
"type": "array",
"description": "Optional array of credit invoice origin types to allow when mode is `all`.\nIf not specified when mod
# --- truncated at 32 KB (65 KB total) ---
# Full source: https://artifacts.apis.io/recurly/json-schema/recurly-purchase-create-schema.json
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/recurly-purchase-create"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.