List Account Credit Payments

List an account's credit payments

GET/accounts/{account_id}/credit_payments

Use it in a workflow

Add a step and choose the Recurly connector.
Pick the List Account Credit Payments action (under credit_payment).
Fill in the fields below, then reference the result from later steps as {{listAccountCreditPayments.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

limitinteger

Limit number of records 1-200.

Default 20

orderstring

Sort order.

One ofascdescDefault "desc"

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 {{listAccountCreditPayments.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

uuidstring

The UUID is useful for matching data with the CSV exports and building URLs into Recurly's UI.

actionstring

The action for which the credit was created.

One ofpaymentreductionrefundwrite_off

accountobject10 fields

applied_to_invoiceobject6 fields

original_invoiceobject6 fields

currencystring

3-letter ISO 4217 currency code.

amountnumber (float)

Total credit payment amount applied to the charge invoice.

original_credit_payment_idstring

For credit payments with action `refund`, this is the credit payment that was refunded.

refund_transactionobject40 fields

created_atstring (date-time)

updated_atstring (date-time)

voided_atstring (date-time)

json

{
  "object": "string",
  "has_more": false,
  "next": "string",
  "data": [
    {
      "id": "string",
      "object": "string",
      "uuid": "string",
      "action": "payment",
      "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"
      },
      "applied_to_invoice": {
        "id": "string",
        "object": "string",
        "number": "string",
        "business_entity_id": "string",
        "type": "charge",
        "state": "all"
      },
      "original_invoice": {
        "id": "string",
        "object": "string",
        "number": "string",
        "business_entity_id": "string",
        "type": "charge",
        "state": "all"
      },
      "currency": "string",
      "amount": 0,
      "original_credit_payment_id": "string",
      "refund_transaction": {
        "id": "string",
        "object": "string",
        "uuid": "string",
        "original_transaction_id": "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"
        },
        "initiator": "customer",
        "invoice": {
          "id": "string",
          "object": "string",
          "number": "string",
          "business_entity_id": "string",
          "type": "charge",
          "state": "all"
        },
        "merchant_reason_code": "none",
        "voided_by_invoice": {
          "id": "string",
          "object": "string",
          "number": "string",
          "business_entity_id": "string",
          "type": "charge",
          "state": "all"
        },
        "subscription_ids": [
          "string"
        ],
        "type": "authorization",
        "origin": "api"
      },
      "created_at": "2025-01-01T00:00:00Z"
    }
  ]
}

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

Was this page helpful?