Recurly · Schema
AccountUpdate
SubscriptionBillingPaymentsRecurring RevenueInvoicingDunningRevenue RecognitionChurnMCPShopifyWebhook
Properties
| Name | Type | Description |
|---|---|---|
| username | string | A secondary value for the account. |
| string | 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. | |
| preferred_locale | object | 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. |
| preferred_time_zone | string | 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#suppo |
| cc_emails | string | 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. |
| first_name | string | |
| last_name | string | |
| company | string | |
| vat_number | string | The VAT number of the account (to avoid having the VAT applied). This is only used for manually collected invoices. |
| tax_exempt | boolean | The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account. |
| exemption_certificate | string | 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. |
| override_business_entity_id | string | Unique ID to identify the business entity assigned to the account. Available when the `Multiple Business Entities` feature is enabled. |
| parent_account_code | string | 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_a |
| parent_account_id | string | 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_i |
| bill_to | object | 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. |
| 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. |
| dunning_campaign_id | string | 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 dunnin |
| invoice_template_id | string | 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 | object | |
| billing_info | object | |
| custom_fields | object | |
| entity_use_code | string | 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 | string | The preferred billing date for the account. This date will be used as the billing date for when activating new subscriptions on the account. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/recurly/json-schema/recurly-account-update-schema.json",
"title": "AccountUpdate",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/recurly-account-api-openapi.yml#/components/schemas/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."
}
},
"$defs": {
"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"
]
},
"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"
]
},
"CustomField": {
"type": "object",
"title": "Custom field",
"properties": {
"name": {
"type": "string",
"title": "Field name",
"description": "Fields must be created in the UI before values can be assigned to them.",
"pattern": "/^[a-z0-9_-]+$/i",
"maxLength": 50
},
"value": {
"type": "string",
"title": "Field value",
"description": "Any values that resemble a credit card number or security code (CVV/CVC) will be rejected.",
"maxLength": 255
},
"source_record_type": {
"type": "string",
"title": "Source record type",
"description": "The type of record this custom field was automatically copied from. Only present when the field was copied from another record.",
"readOnly": true,
"$ref": "#/$defs/SourceRecordTypeEnum"
},
"source_record_id": {
"type": "string",
"title": "Source record ID",
"description": "The UUID of the record this custom field was automatically copied from. Only present when the field was copied from another record.",
"readOnly": true
}
},
"required": [
"name",
"value"
]
},
"CustomFields": {
"type": "array",
"title": "Custom fields",
"description": "The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.",
"items": {
"$ref": "#/$defs/CustomField"
}
},
"ExternalHppTypeEnum": {
"type": "string",
"description": "Use for Adyen HPP billing info. This should only be used as part of a pending purchase request, when the billing info is nested inside an account object.",
"enum": [
"adyen"
]
},
"GatewayTransactionTypeEnum": {
"type": "string",
"enum": [
"moto"
]
},
"OnlineBankingPaymentTypeEnum": {
"type": "string",
"description": "Use for Online Banking billing info. This should only be used as part of a pending purchase request, when the billing info is nested inside an account object.",
"enum": [
"ideal",
"sofort"
]
},
"PaymentGatewayReferences": {
"type": "object",
"title": "Payment Gateway References Object",
"description": "Array of Payment Gateway References, each a reference to a third-party gateway object of varying types.",
"properties": {
"token": {
"type": "string",
"title": "Token",
"description": "Reference value used when the external token was created. If a Stripe gateway or Ebanx gateway is used, this value will need to be accompanied by its reference_type."
},
"reference_type": {
"type": "string",
"title": "Reference Type",
"$ref": "#/$defs/PaymentGatewayReferencesEnum"
}
}
},
"PaymentGatewayReferencesEnum": {
"type": "string",
"description": "The type of reference token. The value can be omitted for gateways that only support one type of token.",
"enum": [
"stripe_confirmation_token",
"upi_vpa"
]
},
"PreferredLocaleEnum": {
"type": "string",
"enum": [
"da-DK",
"de-CH",
"de-DE",
"en-AU",
"en-CA",
"en-GB",
"en-IE",
"en-NZ",
"en-US",
"es-ES",
"es-MX",
"es-US",
"fi-FI",
"fr-BE",
"fr-CA",
"fr-CH",
"fr-FR",
"hi-IN",
"it-IT",
"ja-JP",
"ko-KR",
"nl-BE",
"nl-NL",
"pl-PL",
"pt-BR",
"pt-PT",
"ro-RO",
"ru-RU",
"sk-SK",
"sv-SE",
"tr-TR",
"zh-CN"
]
},
"SourceRecordTypeEnum": {
"type": "string",
"description": "The type of record a custom field was automatically copied from.",
"enum": [
"account",
"plan",
"product",
"subscription"
]
},
"TaxIdentifierTypeEnum": {
"type": "string",
"enum": [
"cpf",
"cnpj",
"cuit"
]
},
"UpiAutopayAuthenticationMethodEnum": {
"type": "string",
"title": "Authentication Method",
"description": "UPI Autopay authentication method. Specifies how the customer authorizes the enrollment mandate. Defaults to 'vpa' if omitted.",
"enum": [
"vpa",
"qr-code",
"app-deep-links"
]
}
}
}
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-account-update"
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.