PlansService_ListAddOns

Staging

https://stg-gateway.invora.app

POST

/api/billing/v2/plans/add-ons/list

List add-ons with filtering and pagination.

Request

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Bodyapplication/json

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://stg-gateway.invora.app/api/billing/v2/plans/add-ons/list' \
--header 'Content-Type: application/json' \
--data '{
    "filter": {
        "textSearch": "string"
    },
    "sort": {
        "rules": [
            {
                "createdAt": "SORT_DIRECTION_UNSPECIFIED"
            }
        ]
    },
    "pagination": {
        "limit": "string",
        "skip": "string",
        "cursor": "string"
    },
    "readMask": "string",
    "view": "VIEW_UNSPECIFIED"
}'

Response Example

200 - Example 1

{
    "items": [
        {
            "amountCents": "string",
            "amountCurrency": "CURRENCY_ENUM_UNSPECIFIED",
            "appliedAddOnsCount": 0,
            "code": "string",
            "createdAt": "2019-08-24T14:15:22.123Z",
            "customersCount": 0,
            "deletedAt": "2019-08-24T14:15:22.123Z",
            "description": "string",
            "id": "string",
            "integrationMappings": [
                {
                    "billingEntityId": "string",
                    "externalAccountCode": "string",
                    "externalId": "string",
                    "externalName": "string",
                    "id": "string",
                    "integrationId": "string",
                    "mappableId": "string",
                    "mappableType": "MAPPABLE_TYPE_ENUM_UNSPECIFIED"
                }
            ],
            "invoiceDisplayName": "string",
            "name": "string",
            "organization": {
                "accessibleByCurrentSession": true,
                "billingConfiguration": {
                    "documentLocale": "string",
                    "id": "string",
                    "invoiceFooter": "string",
                    "invoiceGracePeriod": 0
                },
                "canCreateBillingEntity": true,
                "defaultCurrency": "CURRENCY_ENUM_UNSPECIFIED",
                "id": "string",
                "logoUrl": "string",
                "name": "string",
                "timezone": "TIMEZONE_UNSPECIFIED"
            },
            "taxes": [
                {
                    "addOnsCount": 0,
                    "appliedToOrganization": true,
                    "autoGenerated": true,
                    "chargesCount": 0,
                    "code": "string",
                    "createdAt": "2019-08-24T14:15:22.123Z",
                    "customersCount": 0,
                    "description": "string",
                    "id": "string",
                    "name": "string",
                    "organization": {
                        "accessibleByCurrentSession": true,
                        "billingConfiguration": {
                            "documentLocale": "string",
                            "id": "string",
                            "invoiceFooter": "string",
                            "invoiceGracePeriod": 0
                        },
                        "canCreateBillingEntity": true,
                        "defaultCurrency": "CURRENCY_ENUM_UNSPECIFIED",
                        "id": "string",
                        "logoUrl": "string",
                        "name": "string",
                        "timezone": "TIMEZONE_UNSPECIFIED"
                    },
                    "plansCount": 0,
                    "rate": {
                        "units": "string",
                        "nanos": 0
                    },
                    "updatedAt": "2019-08-24T14:15:22.123Z"
                }
            ],
            "updatedAt": "2019-08-24T14:15:22.123Z"
        }
    ],
    "totalCount": "string",
    "nextPageCursor": "string"
}

Modified at 2026-06-11 18:59:10

PlansService_DeleteAddOn

PlansService_GetAddOn