younifyd
Menu

List Billing Infos

Get the list of billing information associated with an account

GET/accounts/{account_id}/billing_infos

Use it in a workflow

  1. Add a step and choose the Recurly connector.
  2. Pick the List Billing Infos action (under billing_infos).
  3. Fill in the fields below, then reference the result from later steps as {{listBillingInfos.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`.

Query parameters

idsarray<string>

Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. **Important notes:** * The `ids` parameter cannot be used with any other ordering or filtering parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc) * Invalid or unknown IDs will be ignored, so you should check that the results correspond to your request. * Records are returned in an arbitrary order. Since results are all returned at once you can sort the records yourself.

sortstring

Sort field. You *really* only want to sort by `updated_at` in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.

One ofcreated_atupdated_atDefault "created_at"

begin_timestring (date-time)

Inclusively filter by begin_time when `sort=created_at` or `sort=updated_at`. **Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

end_timestring (date-time)

Inclusively filter by end_time when `sort=created_at` or `sort=updated_at`. **Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

Response

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

objectstring

Will always be List.

has_moreboolean

Indicates there are more results on subsequent pages.

nextstring

Path to subsequent page of results.

dataarray<object>
idstring
objectstring
account_idstring
first_namestring
last_namestring
companystring
addressobject8 fields
vat_numberstring

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

validboolean
payment_methodobject19 fields
fraudobject3 fields

Most recent fraud result.

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>2 fields

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

created_atstring (date-time)

When the billing information was created.

updated_atstring (date-time)

When the billing information was last changed.

updated_byobject2 fields
json
{
  "object": "string",
  "has_more": false,
  "next": "string",
  "data": [
    {
      "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.