younifyd
Menu

Update Account

Update an account

PUT/accounts/{account_id}

Use it in a workflow

  1. Add a step and choose the Recurly connector.
  2. Pick the Update Account action (under account).
  3. Fill in the fields below, then reference the result from later steps as {{updateAccount.response.data}}.

Request

Path parameters

account_idstringrequired

Account 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.

usernamestring

A 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_localestring

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.

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_zonestring

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_emailsstring

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_namestring
last_namestring
companystring
vat_numberstring

The VAT number of the account (to avoid having the VAT applied). This is only used for manually collected invoices.

tax_exemptboolean

The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.

exemption_certificatestring

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_idstring

Unique ID to identify the business entity assigned to the account. Available when the `Multiple Business Entities` feature is enabled.

parent_account_codestring

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_idstring

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_tostring

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.

One ofparentself

transaction_typestring

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.

One ofmoto

dunning_campaign_idstring

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_idstring

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.

addressobject
phonestring
street1string
street2string
citystring
regionstring

State or province.

postal_codestring

Zip or postal code.

countrystring

Country, 2-letter ISO 3166-1 alpha-2 code.

geo_codestring

Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled.

billing_infoobject
token_idstring

A token [generated by Recurly.js](https://recurly.com/developers/reference/recurly-js/#getting-a-token).

first_namestring
last_namestring
companystring
addressobject8 fields
numberstring

Credit card number, spaces and dashes are accepted.

monthstring
yearstring
cvvstring

*STRONGLY RECOMMENDED*

currencystring

3-letter ISO 4217 currency code.

vat_numberstring
ip_addressstring

*STRONGLY RECOMMENDED* Customer's IP address when updating their billing information.

gateway_tokenstring
gateway_codestring
payment_gateway_referencesarray<object>2 fields

Array of Payment Gateway References, each a reference to a third-party gateway object of varying types.

gateway_attributesobject1 fields

Additional attributes to send to the gateway.

amazon_billing_agreement_idstring

Only supported on Amazon V1. For Amazon V2, use token_id with Recurly.js.

paypal_billing_agreement_idstring
roku_billing_agreement_idstring
fraud_session_idstring
adyen_risk_profile_reference_idstring

The Adyen Risk Profile Reference ID is used to identify the risk profile for the payment method.

transaction_typestring

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.

One ofmoto

three_d_secure_action_result_token_idstring

A token generated by Recurly.js after completing a 3-D Secure device fingerprinting or authentication challenge.

ibanstring

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_accountstring

The name associated with the bank account (ACH, SEPA, Bacs only)

account_numberstring

The bank account number. (ACH, Bacs only)

routing_numberstring

The bank's rounting number. (ACH only)

sort_codestring

Bank identifier code for UK based banks. Required for Bacs based billing infos. (Bacs only)

typestring

The 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_typestring

The bank account type. (ACH only)

One ofcheckingsavings

tax_identifierstring

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_typestring

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.

One ofcpfcnpjcuit

primary_payment_methodboolean

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_methodboolean

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_typestring

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.

One ofadyen

online_banking_payment_typestring

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.

One ofidealsofort

card_typestring

One ofAmerican ExpressDankortDiners ClubDiscoverELOForbrugsforeningenHipercardJCBLaserMaestroMasterCardTest CardUnion PayUnknownVisaTarjeta Naranja

card_network_preferencestring

Represents the card network preference associated with the billing info for dual badged cards. Must be a supported card network.

One ofBancontactCartesBancairesDankortMasterCardVisa

return_urlstring

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_methodstring

UPI 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.

namestringrequired

Fields must be created in the UI before values can be assigned to them.

valuestringrequired

Any values that resemble a credit card number or security code (CVV/CVC) will be rejected.

source_record_typestring

The type of record a custom field was automatically copied from.

One ofaccountplanproductsubscription

source_record_idstring

The UUID of the record this custom field was automatically copied from. Only present when the field was copied from another record.

entity_use_codestring

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_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.

json
{
  "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.