Get billing history filtered by customer.
GET
/api/customers/recurring-billing/customers/{customerId}/history
deprecated
Requires: Customers.RecurringBilling.ViewHistory, merchant scope.
**Required permissions**: `Customers.RecurringBilling.ViewHistory` **Scope**: merchant
Parameters
| Name | In | Type | Description |
|---|---|---|---|
customerId
required |
path | string (uuid) | |
MerchantId
required |
query | string (uuid) | Optional filter to restrict history to a specific merchant. |
StartDateUtc
required |
query | string (date-time) | Start of date range filter (inclusive). |
EndDateUtc
required |
query | string (date-time) | End of date range filter (inclusive). |
TriggerType
required |
query | PhoeniXGateCustomersRecurringBillingRecurringBillingTriggerType | Optional filter by trigger type (Auto/Manual). |
ContractId
required |
query | string (uuid) | Optional filter to show only runs that included a specific contract. |
CustomerId
required |
query | string (uuid) | Optional filter to show only runs that included a specific customer. |
MaxResultCount
required |
query | integer (int32) | |
ContinuationToken
required |
query | string | |
IncludeDeleted
required |
query | boolean | |
IncludeInactive
required |
query | boolean | |
suppressNulls
required |
query | boolean | If true, omit properties with null values. |
Request body
application/json
, required
| Field | Type | Description |
|---|
This request body has no documented fields.
Responses
200 OK
| Field | Type | Description |
|---|
This response has no documented body fields.
403 Forbidden
| Field | Type | Description |
|---|
This response has no documented body fields.
401 Unauthorized
| Field | Type | Description |
|---|
This response has no documented body fields.
400 Bad Request
| Field | Type | Description |
|---|
This response has no documented body fields.
404 Not Found
| Field | Type | Description |
|---|
This response has no documented body fields.
501 Not Implemented
| Field | Type | Description |
|---|
This response has no documented body fields.
500 Internal Server Error
| Field | Type | Description |
|---|
This response has no documented body fields.
default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.
| Field | Type | Description |
|---|
This response has no documented body fields.
Errors
A failed request returns the platform error envelope. The
error reference lists every value
error.code can carry and shows the four response shapes.