Menu
Update Account
Update an account
/accounts/{account_id}Use it in a workflow
- Add a step and choose the Recurly connector.
- Pick the Update Account action (under account).
- Fill in the fields below, then reference the result from later steps as
{{updateAccount.response.data}}.
Request
Path parameters
account_idstringrequiredAccount ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-bob`.
Request body
Enter the body as JSON in the step's Body field.
usernamestringA secondary value for the account.
emailstring (email)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_localestringUsed 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.
One ofda-DKde-CHde-DEen-AUen-CAen-GBen-IEen-NZen-USes-ESes-MXes-USfi-FIfr-BEfr-CAfr-CHfr-FRhi-INit-ITja-JPko-KRnl-BEnl-NLpl-PLpt-BRpt-PTro-ROru-RUsk-SKsv-SEtr-TRzh-CN
preferred_time_zonestringUsed 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_emailsstringAdditional 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_namestringlast_namestringcompanystringvat_numberstringThe VAT number of the account (to avoid having the VAT applied). This is only used for manually collected invoices.
tax_exemptbooleanThe tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.
exemption_certificatestringThe 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_idstringUnique ID to identify the business entity assigned to the account. Available when the `Multiple Business Entities` feature is enabled.
parent_account_codestringThe 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_idstringThe 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_tostringAn enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.
One ofparentself
transaction_typestringAn 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.
One ofmoto
dunning_campaign_idstringUnique 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_idstringUnique 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.
addressobjectphonestringstreet1stringstreet2stringcitystringregionstringState or province.
postal_codestringZip or postal code.
countrystringCountry, 2-letter ISO 3166-1 alpha-2 code.
geo_codestringCode that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled.
billing_infoobjecttoken_idstringA token [generated by Recurly.js](https://recurly.com/developers/reference/recurly-js/#getting-a-token).
first_namestringlast_namestringcompanystringaddressobject8 fieldsnumberstringCredit card number, spaces and dashes are accepted.
monthstringyearstringcvvstring*STRONGLY RECOMMENDED*
currencystring3-letter ISO 4217 currency code.
vat_numberstringip_addressstring*STRONGLY RECOMMENDED* Customer's IP address when updating their billing information.
gateway_tokenstringgateway_codestringpayment_gateway_referencesarray<object>2 fieldsArray of Payment Gateway References, each a reference to a third-party gateway object of varying types.
gateway_attributesobject1 fieldsAdditional attributes to send to the gateway.
amazon_billing_agreement_idstringOnly supported on Amazon V1. For Amazon V2, use token_id with Recurly.js.
paypal_billing_agreement_idstringroku_billing_agreement_idstringfraud_session_idstringadyen_risk_profile_reference_idstringThe Adyen Risk Profile Reference ID is used to identify the risk profile for the payment method.
transaction_typestringAn 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.
One ofmoto
three_d_secure_action_result_token_idstringA token generated by Recurly.js after completing a 3-D Secure device fingerprinting or authentication challenge.
ibanstringThe 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_accountstringThe name associated with the bank account (ACH, SEPA, Bacs only)
account_numberstringThe bank account number. (ACH, Bacs only)
routing_numberstringThe bank's rounting number. (ACH only)
sort_codestringBank identifier code for UK based banks. Required for Bacs based billing infos. (Bacs only)
typestringThe payment method type for a non-credit card based billing info. `bacs`, `becs`, `pix-automatico`, `mercadopago`, `upi-autopay` are the only accepted values.
One ofbacsbecspix-automaticomercadopagoupi-autopay
account_typestringThe bank account type. (ACH only)
One ofcheckingsavings
tax_identifierstringTax 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_typestringThis 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.
One ofcpfcnpjcuit
primary_payment_methodbooleanThe `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_methodbooleanThe `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_typestringUse 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.
One ofadyen
online_banking_payment_typestringUse 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.
One ofidealsofort
card_typestringOne ofAmerican ExpressDankortDiners ClubDiscoverELOForbrugsforeningenHipercardJCBLaserMaestroMasterCardTest CardUnion PayUnknownVisaTarjeta Naranja
card_network_preferencestringRepresents the card network preference associated with the billing info for dual badged cards. Must be a supported card network.
One ofBancontactCartesBancairesDankortMasterCardVisa
return_urlstringSpecifies 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_methodstringUPI Autopay authentication method. Specifies how the customer authorizes the enrollment mandate. Defaults to 'vpa' if omitted.
One ofvpaqr-codeapp-deep-links
custom_fieldsarray<object>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.
namestringrequiredFields must be created in the UI before values can be assigned to them.
valuestringrequiredAny values that resemble a credit card number or security code (CVV/CVC) will be rejected.
source_record_typestringThe type of record a custom field was automatically copied from.
One ofaccountplanproductsubscription
source_record_idstringThe UUID of the record this custom field was automatically copied from. Only present when the field was copied from another record.
entity_use_codestringThe 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_datestring (date-time)The preferred billing date for the account. This date will be used as the billing date for when activating new subscriptions on the account.
{
"username": "string",
"email": "name@example.com",
"preferred_locale": "da-DK",
"preferred_time_zone": "America/Los_Angeles",
"cc_emails": "string",
"first_name": "string",
"last_name": "string",
"company": "string",
"vat_number": "string",
"tax_exempt": false,
"exemption_certificate": "string",
"override_business_entity_id": "string"
}
Response
Returns 200 with a any. Read it in later steps with {{updateAccount.response.data.<field>}}.
Need more? See the Recurly guide for connection setup and behaviour shared by every action.