Get Billing Info

Fetch an account's billing information

GET/accounts/{account_id}/billing_info

Use it in a workflow

Add a step and choose the Recurly connector.
Pick the Get Billing Info action (under billing_info).
Fill in the fields below, then reference the result from later steps as {{getBillingInfo.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`.

Response

Returns 200 with an object. Read it in later steps with {{getBillingInfo.response.data.<field>}}.

idstring

objectstring

account_idstring

first_namestring

last_namestring

companystring

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.

vat_numberstring

Customer's VAT number (to avoid having the VAT applied). This is only used for automatically collected invoices.

validboolean

payment_methodobject

objectstring

One ofbacsamazonamazon_billing_agreementapple_payapple_pay_merchant_tokenbank_account_infobraintree_apple_paycheckcredit_cardeftgateway_tokengoogle_paygoogle_pay_device_paniban_bank_accountmoney_orderotherpaypalpaypal_billing_agreementrokusepadirectdebitvenmowire_transferbraintree_v_zeroboletocash_appupi_autopaypix_automaticomercadopagoklarnabraintree_google_paystripe_link

card_typestring

Visa, MasterCard, American Express, Discover, JCB, etc.

One ofAmerican ExpressDankortDiners ClubDiscoverELOForbrugsforeningenHipercardJCBLaserMaestroMasterCardTest CardUnion PayUnknownVisaTarjeta Naranja

first_sixstring

Credit card number's first six digits.

last_fourstring

Credit card number's last four digits. Will refer to bank account if payment method is ACH.

last_twostring

The IBAN bank account's last two digits.

exp_monthinteger

Expiration month.

exp_yearinteger

Expiration year.

gateway_tokenstring

A token used in place of a credit card in order to perform transactions.

cc_bin_countrystring

The 2-letter ISO 3166-1 alpha-2 country code associated with the card's issuer, if known.

funding_sourcestring

The funding source of the card, if known.

One ofcreditdebitchargeprepaiddeferred_debit

gateway_codestring

An identifier for a specific payment gateway.

gateway_attributesobject1 fields

Gateway specific attributes associated with this PaymentMethod

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

billing_agreement_idstring

Billing Agreement identifier. Only present for Amazon or Paypal payment methods.

name_on_accountstring

The name associated with the bank account.

account_typestring

The bank account type. Only present for ACH payment methods.

One ofcheckingsavings

routing_numberstring

The bank account's routing number. Only present for ACH payment methods.

routing_number_bankstring

The bank name of this routing number.

usernamestring

Username of the associated payment method. Currently only associated with Venmo.

fraudobject

Most recent fraud result.

scoreinteger

decisionstring

One ofapprovedeclineescalatereview

risk_rules_triggeredobject

primary_payment_methodboolean

The `primary_payment_method` field is used to indicate the primary billing info on the account. The first billing info created on an account will always become primary. This payment method will be used

backup_payment_methodboolean

The `backup_payment_method` field is used to indicate a billing info as a backup on the account that will be tried if the initial billing info used for an invoice is declined.

payment_gateway_referencesarray<object>

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

tokenstring

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_typestring

The type of reference token. Required if token is passed in for Stripe Gateway or Ebanx UPI.

One ofstripe_confirmation_tokenupi_vpa

created_atstring (date-time)

When the billing information was created.

updated_atstring (date-time)

When the billing information was last changed.

updated_byobject

ipstring

Customer's IP address when updating their billing information.

countrystring

Country, 2-letter ISO 3166-1 alpha-2 code matching the origin IP address, if known by Recurly.

json

{
  "id": "string",
  "object": "string",
  "account_id": "string",
  "first_name": "string",
  "last_name": "string",
  "company": "string",
  "address": {
    "phone": "string",
    "street1": "string",
    "street2": "string",
    "city": "string",
    "region": "string",
    "postal_code": "string",
    "country": "string",
    "geo_code": "string"
  },
  "vat_number": "string",
  "valid": false,
  "payment_method": {
    "object": "bacs",
    "card_type": "American Express",
    "first_six": "string",
    "last_four": "string",
    "last_two": "string",
    "exp_month": 0,
    "exp_year": 0,
    "gateway_token": "string",
    "cc_bin_country": "string",
    "funding_source": "credit",
    "gateway_code": "string",
    "gateway_attributes": {
      "account_reference": "string"
    }
  },
  "fraud": {
    "score": 0,
    "decision": "approve",
    "risk_rules_triggered": {}
  },
  "primary_payment_method": false
}

Need more? See the Recurly guide for connection setup and behaviour shared by every action.

Was this page helpful?