younifyd
Menu

Get Account Balance

Fetch an account's balance and past due status

GET/accounts/{account_id}/balance

Use it in a workflow

  1. Add a step and choose the Recurly connector.
  2. Pick the Get Account Balance action (under account).
  3. Fill in the fields below, then reference the result from later steps as {{getAccountBalance.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 {{getAccountBalance.response.data.<field>}}.

objectstring
accountobject
idstring
objectstring
codestring

The unique identifier of the account.

emailstring (email)

The email address used for communicating with this customer.

first_namestring
last_namestring
companystring
parent_account_idstring
bill_tostring
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.

past_dueboolean
balancesarray<object>
currencystring

3-letter ISO 4217 currency code.

amountnumber (float)

Total amount the account is past due.

processing_prepayment_amountnumber (float)

Total amount for the prepayment credit invoices in a `processing` state on the account.

available_credit_amountnumber (float)

Total amount of the open balances on credit invoices for the account.

json
{
  "object": "string",
  "account": {
    "id": "string",
    "object": "string",
    "code": "string",
    "email": "name@example.com",
    "first_name": "string",
    "last_name": "string",
    "company": "string",
    "parent_account_id": "string",
    "bill_to": "string",
    "dunning_campaign_id": "string"
  },
  "past_due": false,
  "balances": [
    {
      "currency": "string",
      "amount": 0,
      "processing_prepayment_amount": 0,
      "available_credit_amount": 0
    }
  ]
}

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