> ## Documentation Index > Fetch the complete documentation index at: https://docs.sequencehq.com/llms.txt > Use this file to discover all available pages before exploring further. # List credit grants > List credit grants on your account, whether held by a customer or on one of their billing schedules, newest first by default. Filter by billing schedule or customer, and use the pagination cursors to retrieve more results. Includes scheduled, unissued, depleted and expired grants. Issuance and validity are reported in `state`; `availableBalance` reports the credit usable now. Usage awaiting processing is not yet deducted from `availableBalance`. ## OpenAPI ````yaml billing.latest.product.live GET /credit-grants openapi: 3.0.0 info: title: Billing description: Manage Billing version: 0.0.1 servers: - url: https://dev.seqhq.io description: E2E - url: https://dev.seqhq.io description: DEV - url: https://sandbox.sequencehq.com description: SANDBOX - url: https://eu.sequencehq.com description: PRODUCTION security: [] tags: - name: Credits - name: Prices - name: Billing Schedules - name: Discounts paths: /credit-grants: servers: [] parameters: [] get: tags: - Credits summary: List credit grants description: >- List credit grants on your account, whether held by a customer or on one of their billing schedules, newest first by default. Filter by billing schedule or customer, and use the pagination cursors to retrieve more results. Includes scheduled, unissued, depleted and expired grants. Issuance and validity are reported in `state`; `availableBalance` reports the credit usable now. Usage awaiting processing is not yet deducted from `availableBalance`. operationId: getCreditGrants parameters: - name: Authorization in: header description: >- Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`. required: true schema: type: string - name: billingScheduleId in: query description: >- Return only the grants belonging to this billing schedule. Customer grants are never included. required: false schema: type: string - name: customerId in: query description: >- Return only the grants held by this customer: those held by the customer directly and those on any of their billing schedules. required: false schema: type: string - name: limit in: query description: Maximum number of grants per page, from 1 to 100. Defaults to 20. required: false schema: type: integer - name: after in: query description: >- Cursor for the next page, from `pagination.after`. Omit for the first page. Use either `after` or `before`, not both. required: false schema: type: string - name: before in: query description: >- Cursor for the previous page, from `pagination.before`. Omit for the first page. Use either `after` or `before`, not both. required: false schema: type: string - name: sortOrder in: query description: >- Order by creation date: DESC for newest first, ASC for oldest first. Defaults to DESC. required: false schema: type: string - name: sequence-version in: header description: Use this header to select an API version required: false schema: type: string enum: - '2024-07-30' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListCreditGrantsV2Response' example: items: - id: 0199ca8a-e7e8-73b3-bd69-a316a23231a0 sequenceAccountId: dce9ae85-d8d0-42b4-bcad-f221a64363c6 customerId: 61b083e0-1faa-47ca-9aeb-6205da8f6c47 scope: SCHEDULE billingScheduleId: 0199ca86-560e-7ac4-999f-bee364f7e4e7 phaseId: 0199ca87-6d80-7836-aa09-10386a08d761 name: Monthly usage credits creditUnitType: CURRENCY currency: GBP metricId: f092246c-6b90-4106-bcca-304ccf06bf45 amount: 100 availableBalance: 79.35 state: issuance: ISSUED validity: CURRENT costOfCredit: 100 taxRateId: 179d1ab3-cc96-48e2-9310-067b0b42d47c effectiveDate: '2026-01-01' expiryDate: '2026-01-31' createdAt: '2026-01-01T10:00:00Z' updatedAt: '2026-01-01T10:00:00Z' grantRefreshFrequency: MONTHLY billingFrequency: MONTHLY rolloverMode: NONE sourceGrantId: 0199ca8a-e7e8-73b3-bd69-a316a2323100 restrictToPrices: - 0199ca89-2d9e-7e3d-914c-7de86e8fc7ce integrationIds: - service: Xero id: 74ed2615-4730-49ab-9445-74f31723a206 isPending: false - id: 0199ca8a-e7e8-73b3-bd69-a316a23231b1 sequenceAccountId: dce9ae85-d8d0-42b4-bcad-f221a64363c6 customerId: 61b083e0-1faa-47ca-9aeb-6205da8f6c47 scope: SCHEDULE billingScheduleId: 0199ca86-560e-7ac4-999f-bee364f7e4e7 phaseId: 0199ca87-6d80-7836-aa09-10386a08d761 name: Next month's usage credits creditUnitType: CURRENCY currency: GBP amount: 100 availableBalance: 0 state: issuance: ISSUED validity: SCHEDULED costOfCredit: 100 taxRateId: 179d1ab3-cc96-48e2-9310-067b0b42d47c effectiveDate: '2026-02-01' expiryDate: '2026-02-28' createdAt: '2026-01-01T10:00:00Z' updatedAt: '2026-01-01T10:00:00Z' grantRefreshFrequency: MONTHLY billingFrequency: MONTHLY rolloverMode: NONE restrictToPrices: - 0199ca89-2d9e-7e3d-914c-7de86e8fc7ce integrationIds: - service: Xero id: 74ed2615-4730-49ab-9445-74f31723a206 isPending: false - id: 0199ca8a-e7e8-73b3-bd69-a316a23231c2 sequenceAccountId: dce9ae85-d8d0-42b4-bcad-f221a64363c6 customerId: 61b083e0-1faa-47ca-9aeb-6205da8f6c47 scope: SCHEDULE billingScheduleId: 0199ca86-560e-7ac4-999f-bee364f7e4e7 phaseId: 0199ca87-6d80-7836-aa09-10386a08d761 name: Prepaid credits creditUnitType: CURRENCY currency: GBP amount: 100 availableBalance: 0 state: issuance: PENDING validity: CURRENT costOfCredit: 100 taxRateId: 179d1ab3-cc96-48e2-9310-067b0b42d47c effectiveDate: '2026-01-01' expiryDate: '2026-01-31' createdAt: '2026-01-01T10:00:00Z' updatedAt: '2026-01-01T10:00:00Z' grantRefreshFrequency: MONTHLY billingFrequency: MONTHLY rolloverMode: NONE restrictToPrices: - 0199ca89-2d9e-7e3d-914c-7de86e8fc7ce integrationIds: - service: Xero id: 74ed2615-4730-49ab-9445-74f31723a206 isPending: false - id: 0199ca8a-e7e8-73b3-bd69-a316a23231d3 sequenceAccountId: dce9ae85-d8d0-42b4-bcad-f221a64363c6 customerId: 61b083e0-1faa-47ca-9aeb-6205da8f6c47 scope: CUSTOMER name: Goodwill credit creditUnitType: CURRENCY currency: GBP amount: 100 availableBalance: 79.35 state: issuance: ISSUED validity: CURRENT costOfCredit: 100 taxRateId: 179d1ab3-cc96-48e2-9310-067b0b42d47c effectiveDate: '2026-01-01' expiryDate: '2026-01-31' createdAt: '2026-01-01T10:00:00Z' updatedAt: '2026-01-01T10:00:00Z' grantRefreshFrequency: NONE billingFrequency: ONE_TIME rolloverMode: NONE restrictToPrices: [] integrationIds: - service: Xero id: 74ed2615-4730-49ab-9445-74f31723a206 isPending: false pagination: after: MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3 before: MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz totalResultSize: 10 examples: ListCreditGrantsV2Response: summary: '' value: items: - id: 0199ca8a-e7e8-73b3-bd69-a316a23231a0 sequenceAccountId: dce9ae85-d8d0-42b4-bcad-f221a64363c6 customerId: 61b083e0-1faa-47ca-9aeb-6205da8f6c47 scope: SCHEDULE billingScheduleId: 0199ca86-560e-7ac4-999f-bee364f7e4e7 phaseId: 0199ca87-6d80-7836-aa09-10386a08d761 name: Monthly usage credits creditUnitType: CURRENCY currency: GBP metricId: f092246c-6b90-4106-bcca-304ccf06bf45 amount: 100 availableBalance: 79.35 state: issuance: ISSUED validity: CURRENT costOfCredit: 100 taxRateId: 179d1ab3-cc96-48e2-9310-067b0b42d47c effectiveDate: '2026-01-01' expiryDate: '2026-01-31' createdAt: '2026-01-01T10:00:00Z' updatedAt: '2026-01-01T10:00:00Z' grantRefreshFrequency: MONTHLY billingFrequency: MONTHLY rolloverMode: NONE sourceGrantId: 0199ca8a-e7e8-73b3-bd69-a316a2323100 restrictToPrices: - 0199ca89-2d9e-7e3d-914c-7de86e8fc7ce integrationIds: - service: Xero id: 74ed2615-4730-49ab-9445-74f31723a206 isPending: false - id: 0199ca8a-e7e8-73b3-bd69-a316a23231b1 sequenceAccountId: dce9ae85-d8d0-42b4-bcad-f221a64363c6 customerId: 61b083e0-1faa-47ca-9aeb-6205da8f6c47 scope: SCHEDULE billingScheduleId: 0199ca86-560e-7ac4-999f-bee364f7e4e7 phaseId: 0199ca87-6d80-7836-aa09-10386a08d761 name: Next month's usage credits creditUnitType: CURRENCY currency: GBP amount: 100 availableBalance: 0 state: issuance: ISSUED validity: SCHEDULED costOfCredit: 100 taxRateId: 179d1ab3-cc96-48e2-9310-067b0b42d47c effectiveDate: '2026-02-01' expiryDate: '2026-02-28' createdAt: '2026-01-01T10:00:00Z' updatedAt: '2026-01-01T10:00:00Z' grantRefreshFrequency: MONTHLY billingFrequency: MONTHLY rolloverMode: NONE restrictToPrices: - 0199ca89-2d9e-7e3d-914c-7de86e8fc7ce integrationIds: - service: Xero id: 74ed2615-4730-49ab-9445-74f31723a206 isPending: false - id: 0199ca8a-e7e8-73b3-bd69-a316a23231c2 sequenceAccountId: dce9ae85-d8d0-42b4-bcad-f221a64363c6 customerId: 61b083e0-1faa-47ca-9aeb-6205da8f6c47 scope: SCHEDULE billingScheduleId: 0199ca86-560e-7ac4-999f-bee364f7e4e7 phaseId: 0199ca87-6d80-7836-aa09-10386a08d761 name: Prepaid credits creditUnitType: CURRENCY currency: GBP amount: 100 availableBalance: 0 state: issuance: PENDING validity: CURRENT costOfCredit: 100 taxRateId: 179d1ab3-cc96-48e2-9310-067b0b42d47c effectiveDate: '2026-01-01' expiryDate: '2026-01-31' createdAt: '2026-01-01T10:00:00Z' updatedAt: '2026-01-01T10:00:00Z' grantRefreshFrequency: MONTHLY billingFrequency: MONTHLY rolloverMode: NONE restrictToPrices: - 0199ca89-2d9e-7e3d-914c-7de86e8fc7ce integrationIds: - service: Xero id: 74ed2615-4730-49ab-9445-74f31723a206 isPending: false - id: 0199ca8a-e7e8-73b3-bd69-a316a23231d3 sequenceAccountId: dce9ae85-d8d0-42b4-bcad-f221a64363c6 customerId: 61b083e0-1faa-47ca-9aeb-6205da8f6c47 scope: CUSTOMER name: Goodwill credit creditUnitType: CURRENCY currency: GBP amount: 100 availableBalance: 79.35 state: issuance: ISSUED validity: CURRENT costOfCredit: 100 taxRateId: 179d1ab3-cc96-48e2-9310-067b0b42d47c effectiveDate: '2026-01-01' expiryDate: '2026-01-31' createdAt: '2026-01-01T10:00:00Z' updatedAt: '2026-01-01T10:00:00Z' grantRefreshFrequency: NONE billingFrequency: ONE_TIME rolloverMode: NONE restrictToPrices: [] integrationIds: - service: Xero id: 74ed2615-4730-49ab-9445-74f31723a206 isPending: false pagination: after: MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3 before: MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz totalResultSize: 10 '400': description: Bad Request content: {} '401': description: Unauthorized content: {} '500': description: Internal Server Error content: {} components: schemas: ListCreditGrantsV2Response: required: - items - pagination type: object example: items: - id: 0199ca8a-e7e8-73b3-bd69-a316a23231a0 sequenceAccountId: dce9ae85-d8d0-42b4-bcad-f221a64363c6 customerId: 61b083e0-1faa-47ca-9aeb-6205da8f6c47 scope: SCHEDULE billingScheduleId: 0199ca86-560e-7ac4-999f-bee364f7e4e7 phaseId: 0199ca87-6d80-7836-aa09-10386a08d761 name: Monthly usage credits creditUnitType: CURRENCY currency: GBP metricId: f092246c-6b90-4106-bcca-304ccf06bf45 amount: 100 availableBalance: 79.35 state: issuance: ISSUED validity: CURRENT costOfCredit: 100 taxRateId: 179d1ab3-cc96-48e2-9310-067b0b42d47c effectiveDate: '2026-01-01' expiryDate: '2026-01-31' createdAt: '2026-01-01T10:00:00Z' updatedAt: '2026-01-01T10:00:00Z' grantRefreshFrequency: MONTHLY billingFrequency: MONTHLY rolloverMode: NONE sourceGrantId: 0199ca8a-e7e8-73b3-bd69-a316a2323100 restrictToPrices: - 0199ca89-2d9e-7e3d-914c-7de86e8fc7ce integrationIds: - service: Xero id: 74ed2615-4730-49ab-9445-74f31723a206 isPending: false - id: 0199ca8a-e7e8-73b3-bd69-a316a23231b1 sequenceAccountId: dce9ae85-d8d0-42b4-bcad-f221a64363c6 customerId: 61b083e0-1faa-47ca-9aeb-6205da8f6c47 scope: SCHEDULE billingScheduleId: 0199ca86-560e-7ac4-999f-bee364f7e4e7 phaseId: 0199ca87-6d80-7836-aa09-10386a08d761 name: Next month's usage credits creditUnitType: CURRENCY currency: GBP amount: 100 availableBalance: 0 state: issuance: ISSUED validity: SCHEDULED costOfCredit: 100 taxRateId: 179d1ab3-cc96-48e2-9310-067b0b42d47c effectiveDate: '2026-02-01' expiryDate: '2026-02-28' createdAt: '2026-01-01T10:00:00Z' updatedAt: '2026-01-01T10:00:00Z' grantRefreshFrequency: MONTHLY billingFrequency: MONTHLY rolloverMode: NONE restrictToPrices: - 0199ca89-2d9e-7e3d-914c-7de86e8fc7ce integrationIds: - service: Xero id: 74ed2615-4730-49ab-9445-74f31723a206 isPending: false - id: 0199ca8a-e7e8-73b3-bd69-a316a23231c2 sequenceAccountId: dce9ae85-d8d0-42b4-bcad-f221a64363c6 customerId: 61b083e0-1faa-47ca-9aeb-6205da8f6c47 scope: SCHEDULE billingScheduleId: 0199ca86-560e-7ac4-999f-bee364f7e4e7 phaseId: 0199ca87-6d80-7836-aa09-10386a08d761 name: Prepaid credits creditUnitType: CURRENCY currency: GBP amount: 100 availableBalance: 0 state: issuance: PENDING validity: CURRENT costOfCredit: 100 taxRateId: 179d1ab3-cc96-48e2-9310-067b0b42d47c effectiveDate: '2026-01-01' expiryDate: '2026-01-31' createdAt: '2026-01-01T10:00:00Z' updatedAt: '2026-01-01T10:00:00Z' grantRefreshFrequency: MONTHLY billingFrequency: MONTHLY rolloverMode: NONE restrictToPrices: - 0199ca89-2d9e-7e3d-914c-7de86e8fc7ce integrationIds: - service: Xero id: 74ed2615-4730-49ab-9445-74f31723a206 isPending: false - id: 0199ca8a-e7e8-73b3-bd69-a316a23231d3 sequenceAccountId: dce9ae85-d8d0-42b4-bcad-f221a64363c6 customerId: 61b083e0-1faa-47ca-9aeb-6205da8f6c47 scope: CUSTOMER name: Goodwill credit creditUnitType: CURRENCY currency: GBP amount: 100 availableBalance: 79.35 state: issuance: ISSUED validity: CURRENT costOfCredit: 100 taxRateId: 179d1ab3-cc96-48e2-9310-067b0b42d47c effectiveDate: '2026-01-01' expiryDate: '2026-01-31' createdAt: '2026-01-01T10:00:00Z' updatedAt: '2026-01-01T10:00:00Z' grantRefreshFrequency: NONE billingFrequency: ONE_TIME rolloverMode: NONE restrictToPrices: [] integrationIds: - service: Xero id: 74ed2615-4730-49ab-9445-74f31723a206 isPending: false pagination: after: MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3 before: MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz totalResultSize: 10 properties: items: type: array description: >- Credit grants on this page, held by a customer or on a billing schedule. example: - id: 0199ca8a-e7e8-73b3-bd69-a316a23231a0 sequenceAccountId: dce9ae85-d8d0-42b4-bcad-f221a64363c6 customerId: 61b083e0-1faa-47ca-9aeb-6205da8f6c47 scope: SCHEDULE billingScheduleId: 0199ca86-560e-7ac4-999f-bee364f7e4e7 phaseId: 0199ca87-6d80-7836-aa09-10386a08d761 name: Monthly usage credits creditUnitType: CURRENCY currency: GBP metricId: f092246c-6b90-4106-bcca-304ccf06bf45 amount: 100 availableBalance: 79.35 state: issuance: ISSUED validity: CURRENT costOfCredit: 100 taxRateId: 179d1ab3-cc96-48e2-9310-067b0b42d47c effectiveDate: '2026-01-01' expiryDate: '2026-01-31' createdAt: '2026-01-01T10:00:00Z' updatedAt: '2026-01-01T10:00:00Z' grantRefreshFrequency: MONTHLY billingFrequency: MONTHLY rolloverMode: NONE sourceGrantId: 0199ca8a-e7e8-73b3-bd69-a316a2323100 restrictToPrices: - 0199ca89-2d9e-7e3d-914c-7de86e8fc7ce integrationIds: - service: Xero id: 74ed2615-4730-49ab-9445-74f31723a206 isPending: false - id: 0199ca8a-e7e8-73b3-bd69-a316a23231b1 sequenceAccountId: dce9ae85-d8d0-42b4-bcad-f221a64363c6 customerId: 61b083e0-1faa-47ca-9aeb-6205da8f6c47 scope: SCHEDULE billingScheduleId: 0199ca86-560e-7ac4-999f-bee364f7e4e7 phaseId: 0199ca87-6d80-7836-aa09-10386a08d761 name: Next month's usage credits creditUnitType: CURRENCY currency: GBP amount: 100 availableBalance: 0 state: issuance: ISSUED validity: SCHEDULED costOfCredit: 100 taxRateId: 179d1ab3-cc96-48e2-9310-067b0b42d47c effectiveDate: '2026-02-01' expiryDate: '2026-02-28' createdAt: '2026-01-01T10:00:00Z' updatedAt: '2026-01-01T10:00:00Z' grantRefreshFrequency: MONTHLY billingFrequency: MONTHLY rolloverMode: NONE restrictToPrices: - 0199ca89-2d9e-7e3d-914c-7de86e8fc7ce integrationIds: - service: Xero id: 74ed2615-4730-49ab-9445-74f31723a206 isPending: false - id: 0199ca8a-e7e8-73b3-bd69-a316a23231c2 sequenceAccountId: dce9ae85-d8d0-42b4-bcad-f221a64363c6 customerId: 61b083e0-1faa-47ca-9aeb-6205da8f6c47 scope: SCHEDULE billingScheduleId: 0199ca86-560e-7ac4-999f-bee364f7e4e7 phaseId: 0199ca87-6d80-7836-aa09-10386a08d761 name: Prepaid credits creditUnitType: CURRENCY currency: GBP amount: 100 availableBalance: 0 state: issuance: PENDING validity: CURRENT costOfCredit: 100 taxRateId: 179d1ab3-cc96-48e2-9310-067b0b42d47c effectiveDate: '2026-01-01' expiryDate: '2026-01-31' createdAt: '2026-01-01T10:00:00Z' updatedAt: '2026-01-01T10:00:00Z' grantRefreshFrequency: MONTHLY billingFrequency: MONTHLY rolloverMode: NONE restrictToPrices: - 0199ca89-2d9e-7e3d-914c-7de86e8fc7ce integrationIds: - service: Xero id: 74ed2615-4730-49ab-9445-74f31723a206 isPending: false - id: 0199ca8a-e7e8-73b3-bd69-a316a23231d3 sequenceAccountId: dce9ae85-d8d0-42b4-bcad-f221a64363c6 customerId: 61b083e0-1faa-47ca-9aeb-6205da8f6c47 scope: CUSTOMER name: Goodwill credit creditUnitType: CURRENCY currency: GBP amount: 100 availableBalance: 79.35 state: issuance: ISSUED validity: CURRENT costOfCredit: 100 taxRateId: 179d1ab3-cc96-48e2-9310-067b0b42d47c effectiveDate: '2026-01-01' expiryDate: '2026-01-31' createdAt: '2026-01-01T10:00:00Z' updatedAt: '2026-01-01T10:00:00Z' grantRefreshFrequency: NONE billingFrequency: ONE_TIME rolloverMode: NONE restrictToPrices: [] integrationIds: - service: Xero id: 74ed2615-4730-49ab-9445-74f31723a206 isPending: false items: $ref: '#/components/schemas/CreditGrantV2Response' pagination: $ref: '#/components/schemas/PaginationMeta' CreditGrantV2Response: required: - amount - availableBalance - billingFrequency - createdAt - creditUnitType - customerId - grantRefreshFrequency - id - integrationIds - name - restrictToPrices - rolloverMode - scope - sequenceAccountId - state - updatedAt type: object example: id: 0199ca8a-e7e8-73b3-bd69-a316a23231a0 sequenceAccountId: dce9ae85-d8d0-42b4-bcad-f221a64363c6 customerId: 61b083e0-1faa-47ca-9aeb-6205da8f6c47 scope: SCHEDULE billingScheduleId: 0199ca86-560e-7ac4-999f-bee364f7e4e7 phaseId: 0199ca87-6d80-7836-aa09-10386a08d761 name: Monthly usage credits creditUnitType: CURRENCY currency: GBP metricId: f092246c-6b90-4106-bcca-304ccf06bf45 amount: 100 availableBalance: 79.35 state: issuance: ISSUED validity: CURRENT costOfCredit: 100 taxRateId: 179d1ab3-cc96-48e2-9310-067b0b42d47c effectiveDate: '2026-01-01' expiryDate: '2026-01-31' createdAt: '2026-01-01T10:00:00Z' updatedAt: '2026-01-01T10:00:00Z' grantRefreshFrequency: MONTHLY billingFrequency: MONTHLY rolloverMode: NONE sourceGrantId: 0199ca8a-e7e8-73b3-bd69-a316a2323100 restrictToPrices: - 0199ca89-2d9e-7e3d-914c-7de86e8fc7ce integrationIds: - service: Xero id: 74ed2615-4730-49ab-9445-74f31723a206 isPending: false properties: id: type: string description: Credit grant ID. example: 0199ca8a-e7e8-73b3-bd69-a316a23231a0 sequenceAccountId: type: string description: Sequence account ID. example: dce9ae85-d8d0-42b4-bcad-f221a64363c6 customerId: type: string description: ID of the customer receiving the credit. example: 61b083e0-1faa-47ca-9aeb-6205da8f6c47 scope: $ref: '#/components/schemas/GrantScope' description: >- Whether the grant is held by the customer directly (CUSTOMER) or belongs to one of their billing schedules (SCHEDULE). billingScheduleId: type: string description: >- ID of the billing schedule the grant belongs to. Absent for a customer grant. nullable: true example: 0199ca86-560e-7ac4-999f-bee364f7e4e7 phaseId: type: string description: >- ID of the billing schedule phase the grant belongs to. Absent for a customer grant. nullable: true example: 0199ca87-6d80-7836-aa09-10386a08d761 name: type: string description: Name of the credit grant. example: Monthly usage credits creditUnitType: $ref: '#/components/schemas/CreditUnitType' description: Whether credit is measured in currency or usage-metric units. currency: $ref: '#/components/schemas/Currency' description: >- Currency the grant is denominated in. Null when creditUnitType is METRIC. nullable: true metricId: type: string description: >- ID of the usage metric the credit is measured in when creditUnitType is METRIC. nullable: true example: f092246c-6b90-4106-bcca-304ccf06bf45 amount: type: number description: >- The configured credit allowance. Available credit may exceed this amount after rollover. The difference between this amount and available credit does not represent usage. example: 100 availableBalance: type: number description: >- Credit currently available for eligible prices. Never negative. Zero before the effective date, while awaiting issuance, when no credit remains, or after expiry. Usage awaiting processing is not yet deducted. Dates are evaluated in UTC and are inclusive. example: 79.35 state: $ref: '#/components/schemas/CreditGrantStateResponse' costOfCredit: type: number description: The amount charged to the customer for the credit grant. nullable: true example: 100 taxRateId: type: string description: Tax rate ID for the credit grant. nullable: true example: 179d1ab3-cc96-48e2-9310-067b0b42d47c effectiveDate: type: string description: First day the credit can be used, inclusive, in UTC. nullable: true example: '2026-01-01' expiryDate: type: string description: Last day the credit can be used, inclusive, in UTC. nullable: true example: '2026-01-31' createdAt: type: string description: When the credit grant was created. example: '2026-01-01T10:00:00Z' updatedAt: type: string description: >- When the grant's configuration last changed. Changes to the available balance do not update this timestamp. example: '2026-01-01T10:00:00Z' grantRefreshFrequency: $ref: '#/components/schemas/GrantRefreshFrequency' description: How often the credit grant refreshes its balance. billingFrequency: $ref: '#/components/schemas/GrantBillingFrequency' description: How often the customer is charged for the credit grant. rolloverMode: $ref: '#/components/schemas/RolloverMode' description: Whether unused balance carries over when the grant refreshes. sourceGrantId: type: string description: ID of the grant whose unused credit was rolled over into this grant. nullable: true example: 0199ca8a-e7e8-73b3-bd69-a316a2323100 restrictToPrices: type: array description: >- IDs of prices eligible to use this credit. Includes all prices in the phase when no restriction was specified. Empty for a customer grant. example: - 0199ca89-2d9e-7e3d-914c-7de86e8fc7ce items: type: string integrationIds: type: array description: Identifiers for this credit grant in external integrations. example: - service: Xero id: 74ed2615-4730-49ab-9445-74f31723a206 isPending: false items: $ref: '#/components/schemas/IntegrationId' PaginationMeta: type: object description: Results pagination example: after: MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3 before: MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz totalResultSize: 10 properties: after: type: string description: Cursor for the page after this (if it exists) nullable: true example: MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3 before: type: string description: Cursor for the page before this (if it exists) nullable: true example: MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz totalResultSize: type: integer description: Total number of entries across all pages format: int64 nullable: true example: 10 GrantScope: type: string example: SCHEDULE enum: - CUSTOMER - SCHEDULE CreditUnitType: type: string example: CURRENCY enum: - CURRENCY - METRIC Currency: type: string example: GBP enum: - AED - ARS - AUD - BRL - BGN - CAD - CHF - CLP - CNY - COP - CZK - DKK - EGP - EUR - GBP - HKD - ILS - INR - ISK - JPY - KRW - MXN - NOK - NZD - PLN - SAR - SEK - SGD - THB - USD - UYU - ZAR CreditGrantStateResponse: required: - issuance - validity type: object description: >- Independent issuance and date-validity states. availableBalance reports the credit usable now. example: issuance: ISSUED validity: CURRENT properties: issuance: $ref: '#/components/schemas/CreditGrantIssuance' description: >- PENDING until the grant's credits are issued; ISSUED thereafter, including after depletion or expiry. Cash credits are issued when their charging invoice is finalised; this does not confirm payment. Metric grants are always ISSUED. Applies to the grant, not individual recurring allowances. validity: $ref: '#/components/schemas/CreditGrantValidity' description: >- SCHEDULED before the effective date, CURRENT within the validity window, or EXPIRED after the expiry date. Dates are inclusive and evaluated in UTC; a missing date leaves that boundary unrestricted. CURRENT does not imply issued credits or a positive available balance. GrantRefreshFrequency: type: string example: MONTHLY enum: - NONE - MONTHLY - QUARTERLY - HALF_YEARLY - YEARLY GrantBillingFrequency: type: string example: MONTHLY enum: - ONE_TIME - MONTHLY - QUARTERLY - HALF_YEARLY - YEARLY RolloverMode: type: string example: NONE enum: - NONE - ON_GRANT_REFRESH - ON_GRANT_REFRESH_AND_PHASE IntegrationId: required: - id - isPending - service type: object example: service: Xero id: 74ed2615-4730-49ab-9445-74f31723a206 isPending: false properties: service: $ref: '#/components/schemas/IntegrationService' id: type: string example: 74ed2615-4730-49ab-9445-74f31723a206 isPending: type: boolean example: false CreditGrantIssuance: type: string example: ISSUED enum: - PENDING - ISSUED CreditGrantValidity: type: string example: CURRENT enum: - SCHEDULED - CURRENT - EXPIRED IntegrationService: type: string example: Xero enum: - Amazon_Redshift - GoCardless - Google_BigQuery - Google_Sheets - HubSpot - NetSuite - QuickBooks_Online - Salesforce - Slack - Snowflake - Stripe - Xero - Avalara - Anrok - Attio - Numeral - Rillet - Sphere ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.