> ## Documentation Index > Fetch the complete documentation index at: https://docs.slash.com/llms.txt > Use this file to discover all available pages before exploring further. # List invoice series > List recurring invoice series. ## OpenAPI ````yaml /openapi-v2.json get /v2/invoices/series openapi: 3.1.0 info: title: Slash Public API V2 description: >- Send money for a Slash legal entity. Every request uses an API key. Transfer creation returns a Transfer that links its resulting transactions. version: 0.0.1 servers: - url: https://api.slash.com description: production security: - api_key: [] paths: /v2/invoices/series: parameters: - name: x-legal-entity in: header required: true description: >- The legal entity to act on. Required on every request; a user API key can act on any legal entity its user has access to. schema: type: string pattern: ^le_[a-zA-Z0-9]+$ get: summary: List invoice series description: List recurring invoice series. parameters: - name: cursor in: query required: false description: >- The opaque `metadata.nextCursor` value from the previous page. It carries that page's filters, page size and ordering, so pass it on its own; see [Pagination](/docs/v2/get-started/pagination). schema: type: string - name: limit in: query required: false description: >- Number of items per page, from 1 to 100. The page size is carried inside `metadata.nextCursor`, so later pages keep the same size unless `limit` is passed again to change it. schema: type: integer minimum: 1 maximum: 100 - name: sort in: query required: false description: >- Field to order the page by. Each value has its own default direction, used unless `sortDirection` is passed. See [Sorting](/docs/v2/get-started/pagination#sorting). - `createdAt` (default) — descending - `startDate` — descending - `nextInvoiceDate` — descending schema: type: string enum: - createdAt - startDate - nextInvoiceDate default: createdAt - name: sortDirection in: query required: false description: >- Direction of the ordering selected by `sort`. When omitted, each `sort` value uses its own default; see [Sorting](/docs/v2/get-started/pagination#sorting). schema: type: string enum: - asc - desc - name: status in: query required: false description: Return only series in these statuses. style: form explode: false schema: type: array items: type: string enum: - active - ended - cancelled - name: customerId in: query required: false description: Return only series for one customer. schema: type: string responses: '200': description: A page of series. content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/invoice-series' metadata: $ref: '#/components/schemas/pagination-metadata' required: - items - metadata additionalProperties: false '400': $ref: '#/components/responses/PublicApiV2Error400InvoicesSeriesList' '401': $ref: '#/components/responses/PublicApiV2Error401Unauthorized' '403': $ref: >- #/components/responses/PublicApiV2Error403FeatureNotEnabledForbiddenLegalEntityNotAvailableUserApiKeyRequired '404': $ref: '#/components/responses/PublicApiV2Error404NotFound' '429': $ref: '#/components/responses/PublicApiV2RateLimited' '500': $ref: '#/components/responses/PublicApiV2Error500Internal' security: - api_key: [] components: schemas: invoice-series: title: InvoiceSeries description: >- Issues the same invoice to a customer on a schedule. Each invoice is created `scheduled` ahead of its send date, is sent at 9:00 in the series' `timezone`, and then behaves like any other invoice. All amounts are in USD. type: object properties: id: type: string description: Series id with the `inv_series_` prefix. example: inv_series_2rj4l7hmrrrcv status: type: string enum: - active - ended - cancelled description: >- See [How a series works](/docs/v2/invoices/recurring-invoices#how-a-series-works). customerId: type: string description: Customer id with the `le_cus_` prefix. accountId: type: string description: The account payments settle into, with the `sa_group_` prefix. virtualAccountId: type: string description: >- The virtual account payments settle into, with the `subaccount_` prefix. Absent when they settle into the account's primary virtual account. recurrence: $ref: '#/components/schemas/invoice-series-recurrence' startDate: type: string format: date description: The first day the series can issue an invoice on. timezone: type: string description: The IANA timezone the series' dates are in. example: America/New_York paymentTermsDays: type: integer description: Each invoice is due this many days after it's issued. end: $ref: '#/components/schemas/invoice-series-end' lineItems: type: array items: $ref: '#/components/schemas/invoice-line-item' discount: $ref: '#/components/schemas/invoice-discount' taxRate: type: number description: Tax as a percent of the subtotal after the discount. amounts: type: object description: Each invoice's amounts. properties: subtotal: $ref: '#/components/schemas/Money' discount: $ref: '#/components/schemas/Money' tax: $ref: '#/components/schemas/Money' total: $ref: '#/components/schemas/Money' required: - subtotal - discount - tax - total memo: type: string ccEmails: type: array items: type: string paymentMethods: type: array items: $ref: '#/components/schemas/invoice-payment-method' nextInvoiceDate: type: string format: date description: When the next invoice goes out. Only on `active` series. nextInvoiceId: type: string description: >- The next invoice, already created as `scheduled`, with the `inv_` prefix. Only on `active` series. createdAt: type: string format: date-time required: - id - status - accountId - recurrence - startDate - timezone - paymentTermsDays - end - lineItems - amounts - ccEmails - paymentMethods - createdAt pagination-metadata: title: PaginationMetadata type: object properties: nextCursor: type: string description: Opaque cursor for the next page. Omitted on the final page. count: type: integer minimum: 0 description: Number of items in this page. required: - count additionalProperties: false invoice-series-recurrence: title: InvoiceSeriesRecurrence description: Which days the series issues an invoice on. oneOf: - title: Weekly type: object properties: type: type: string enum: - weekly dayOfWeek: type: integer minimum: 0 maximum: 6 description: '`0` is Sunday.' required: - type - dayOfWeek additionalProperties: false - title: Monthly on a date type: object properties: type: type: string enum: - monthly_day_of_month dayOfMonth: type: integer minimum: 1 maximum: 31 description: In shorter months, the last day of the month. required: - type - dayOfMonth additionalProperties: false - title: Monthly on a weekday type: object properties: type: type: string enum: - monthly_nth_weekday nth: oneOf: - type: integer minimum: 1 maximum: 4 - type: string enum: - last description: Which occurrence of `dayOfWeek` in the month. dayOfWeek: type: integer minimum: 0 maximum: 6 description: '`0` is Sunday.' required: - type - nth - dayOfWeek additionalProperties: false invoice-series-end: title: InvoiceSeriesEnd description: When the series stops issuing invoices. oneOf: - title: Never type: object properties: type: type: string enum: - never required: - type additionalProperties: false - title: After a number of invoices type: object properties: type: type: string enum: - after_count count: type: integer minimum: 1 description: How many invoices the series issues in all. required: - type - count additionalProperties: false - title: On a date type: object properties: type: type: string enum: - on_date date: type: string format: date description: No invoices are issued after this day. required: - type - date additionalProperties: false invoice-line-item: title: InvoiceLineItem type: object properties: name: type: string example: Robot arm maintenance quantity: type: number example: 2 unitAmount: $ref: '#/components/schemas/Money' total: allOf: - $ref: '#/components/schemas/Money' description: '`quantity` times `unitAmount`.' catalogItemId: type: string description: >- The catalog item the line was added from, with the `cat_item_` prefix. The line keeps the name and price it was written with. required: - name - quantity - unitAmount - total invoice-discount: title: InvoiceDiscount description: Taken off the line items' subtotal before tax. oneOf: - title: Percentage type: object properties: type: type: string enum: - percentage percent: type: number description: Percent of the subtotal. `10` means 10%. example: 10 required: - type - percent - title: Fixed type: object properties: type: type: string enum: - fixed amount: $ref: '#/components/schemas/Money' required: - type - amount Money: type: object description: A signed monetary amount expressed in minor units. properties: amount: type: integer description: Amount in the currency's minor units. currency: type: string pattern: ^[A-Z]{3}$ description: Uppercase ISO 4217 currency code. required: - amount - currency additionalProperties: false title: Money invoice-payment-method: title: InvoicePaymentMethod description: A way the payer can pay on the invoice's payment page. type: object properties: type: type: string enum: - bank_transfer - ach_debit - card - crypto description: >- `bank_transfer` (ACH, wire or realtime payment to the account's details) is always offered. passFeeToPayer: type: boolean description: Whether the payer covers the method's processing fee. required: - type - passFeeToPayer PublicApiV2ErrorInvalidRequestShape: title: PublicApiV2ErrorInvalidRequestShape description: >- The body, query, or headers failed validation, or a required header is missing. `details` has one entry per failing location, keyed by JSON pointer or header name. allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string enum: - invalid_request details: type: object properties: {} additionalProperties: type: string required: - code - details PublicApiV2ErrorUnauthorized: title: PublicApiV2ErrorUnauthorized description: API key authentication is missing or invalid. allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string enum: - unauthorized details: type: object properties: {} additionalProperties: false required: - code - details PublicApiV2ErrorFeatureNotEnabled: title: PublicApiV2ErrorFeatureNotEnabled description: >- The feature this request uses is not enabled for the legal entity. Contact Slash support to enable it. allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string enum: - feature_not_enabled details: type: object properties: {} additionalProperties: false required: - code - details PublicApiV2ErrorForbiddenLegalEntity: title: PublicApiV2ErrorForbiddenLegalEntity description: The credential is not permitted to act for the selected legal entity. allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string enum: - forbidden details: type: object properties: {} additionalProperties: false required: - code - details PublicApiV2ErrorNotAvailable: title: PublicApiV2ErrorNotAvailable description: >- Public API v2 is not yet available. Use [Public API v1](https://docs.slash.com/introduction) in the meantime. allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string enum: - not_available details: type: object properties: {} additionalProperties: false required: - code - details PublicApiV2ErrorUserApiKeyRequired: title: PublicApiV2ErrorUserApiKeyRequired description: >- The API key is scoped to a legal entity rather than a user. Every v2 request needs a user API key, created under Settings → API keys in the Slash dashboard, together with the `x-legal-entity` header. allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string enum: - user_api_key_required details: type: object properties: {} additionalProperties: false required: - code - details PublicApiV2ErrorNotFound: title: PublicApiV2ErrorNotFound description: >- No resource matches the identifier. When the identifier is a field of the request, `details` names that `field` and the `id` it received. allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string enum: - not_found details: type: object properties: field: type: string description: Dot path of the request field at fault. id: type: string description: The identifier that field carried, when it is one. additionalProperties: false required: - code - details PublicApiV2ErrorInternal: title: PublicApiV2ErrorInternal description: >- Slash could not complete the request. Quote `referenceId` when contacting Slash support. allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string enum: - internal details: type: object properties: {} additionalProperties: false required: - code - details Error: type: object properties: code: type: string description: >- Machine-readable reason; branch on this, not on `message`. Every code an endpoint can return is listed on its reference page; the ones shared by all endpoints are explained in the Errors guide. example: invalid_request message: type: string description: >- Human-readable explanation, safe to show to an operator. Wording may change; use `code` and `details` programmatically. details: type: object description: >- The values behind `message`, keyed per `code`. For example `insufficient_funds` carries `available` and `requested`; `invalid_request` from contract validation carries one entry per failing field, keyed by JSON pointer. Empty when the code has no variable data. additionalProperties: type: string example: available: $120.00 requested: $500.00 referenceId: type: string description: Unique id of this failure. Quote it when contacting Slash support. example: 4001-2alj5if required: - code - message - details - referenceId additionalProperties: false title: Error responses: PublicApiV2Error400InvoicesSeriesList: description: >- - `invalid_request (request shape)` — The body, query, or headers failed validation, or a required header is missing. `details` has one entry per failing location, keyed by JSON pointer or header name. content: application/json: schema: $ref: '#/components/schemas/PublicApiV2ErrorInvalidRequestShape' examples: invalid_request_request_shape: summary: invalid_request (request shape) value: code: invalid_request message: >- Invalid `customerId`: Expected a valid ID beginning with "le_cus_". details: /customerId: Expected a valid ID beginning with "le_cus_". referenceId: 4001-2alj5if PublicApiV2Error401Unauthorized: description: '- `unauthorized` — API key authentication is missing or invalid.' content: application/json: schema: $ref: '#/components/schemas/PublicApiV2ErrorUnauthorized' examples: unauthorized: summary: unauthorized value: code: unauthorized message: API key authentication is missing or invalid. details: {} referenceId: 4011-2alj5if PublicApiV2Error403FeatureNotEnabledForbiddenLegalEntityNotAvailableUserApiKeyRequired: description: >- - `feature_not_enabled` — The feature this request uses is not enabled for the legal entity. Contact Slash support to enable it. - `forbidden (legal entity)` — The credential is not permitted to act for the selected legal entity. - `not_available` — Public API v2 is not yet available. Use [Public API v1](https://docs.slash.com/introduction) in the meantime. - `user_api_key_required` — The API key is scoped to a legal entity rather than a user. Every v2 request needs a user API key, created under Settings → API keys in the Slash dashboard, together with the `x-legal-entity` header. content: application/json: schema: anyOf: - title: feature_not_enabled allOf: - $ref: '#/components/schemas/PublicApiV2ErrorFeatureNotEnabled' - title: forbidden (legal entity) allOf: - $ref: '#/components/schemas/PublicApiV2ErrorForbiddenLegalEntity' - title: not_available allOf: - $ref: '#/components/schemas/PublicApiV2ErrorNotAvailable' - title: user_api_key_required allOf: - $ref: '#/components/schemas/PublicApiV2ErrorUserApiKeyRequired' examples: feature_not_enabled: summary: feature_not_enabled value: code: feature_not_enabled message: >- This feature is not enabled for you. Please contact support to get it. details: {} referenceId: 4031-2alj5if forbidden_legal_entity: summary: forbidden (legal entity) value: code: forbidden message: This credential is not permitted to do that. details: {} referenceId: 4031-2alj5if not_available: summary: not_available value: code: not_available message: >- Public API v2 is not yet available. Use Public API v1 (https://docs.slash.com/introduction) in the meantime. details: {} referenceId: 4031-2alj5if user_api_key_required: summary: user_api_key_required value: code: user_api_key_required message: >- Public API v2 requires a user API key. Create one under Settings → API keys in the Slash dashboard. details: {} referenceId: 4031-2alj5if PublicApiV2Error404NotFound: description: >- - `not_found` — No resource matches the identifier. When the identifier is a field of the request, `details` names that `field` and the `id` it received. content: application/json: schema: $ref: '#/components/schemas/PublicApiV2ErrorNotFound' examples: not_found: summary: not_found value: code: not_found message: The requested resource was not found. details: {} referenceId: 4041-2alj5if PublicApiV2RateLimited: description: >- The request exceeded the applicable rate limit. The response body is plain text, not the error object; clients must not depend on its wording. content: text/plain: schema: type: string example: You are rate limited PublicApiV2Error500Internal: description: >- - `internal` — Slash could not complete the request. Quote `referenceId` when contacting Slash support. content: application/json: schema: $ref: '#/components/schemas/PublicApiV2ErrorInternal' examples: internal: summary: internal value: code: internal message: >- An unexpected error occurred. If this keeps happening, contact Slash support with the reference id below. details: {} referenceId: 5001-2alj5if securitySchemes: api_key: type: apiKey name: X-API-Key in: header description: >- User API key authentication. Create a key under Settings → API keys in the Slash dashboard (https://app.slash.com/global-settings/api-keys) and send the `x-legal-entity` header naming the legal entity to act on with every request. Keys scoped to a legal entity are rejected with `403 user_api_key_required`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.