--- title: "GET /api/subscriptions" method: GET path: "/api/subscriptions" tags: ["api"] --- # GET /api/subscriptions `GET /api/subscriptions` Get all Subscriptions ## Query parameters - `top` number, float — A limit on the number of objects to be returned. Can range between 1 and 1000. - `skip` number, float — The number of objects to skip for the requested result - `customerId` string - `planId` string - `planVariantIds` string[] - `eventId` string - `customerPaymentMethodId` string - `updatedAt` object - `$gt` string, date-time — value is greater than - `$gte` string, date-time — value is greater than or equal - `$lt` string, date-time — value is less than - `$lte` string, date-time — value is less than or equal - `$eq` string, date-time — value is equal - `$ne` string, date-time — value is not equal - `status` string[] ## Response `200` OK - GETApiGetAllSubscriptions200Response - `docs` SubscriptionResource[] - `_id` string, required — The ID of the subscription - `sellerId` string, required — The ID of the seller of the subscription - `status` 'DRAFT' | 'ACTIVE' | 'INCOMPLETE' | 'CANCELED' | 'ARCHIVED' | 'PENDING-CANCELLATION', required — The status of the subscription - `customerId` string, required — The ID of the customer of the subscription - `planId` string, required — The ID of the plan of the subscription - `currency` 'EUR' | 'USD' | 'GBP' | 'AUD' | 'CHF' | 'THB' | 'ILS' | 'COP' | 'MXN' | 'DKK' | 'NOK' | 'SEK' | 'QAR' | 'CAD' | 'ISK' | 'GTQ' | 'INR' | 'DOP' | 'SGD' | 'PLN' | 'SAR' | 'TTD' | 'ZAR' | 'KYD' | 'HKD' | 'CZK' | 'KRW' | 'JPY' | 'NZD' | 'AED' | 'MAD' | 'TWD' | 'BRL' | 'BWP' | 'NAD' | 'KES' | 'SCR' | 'TRY' | 'SZL' | 'LSL' | 'TZS' | 'UGX' | 'ZMW' | 'ZWG' | 'GHS' | 'NGN' | 'SLE' | 'LRD' | 'XOF' | 'XAF' | 'GEL' | 'IDR' | 'ARS' | 'CRC' | 'HUF' | 'EGP' | 'MYR' | 'VND' | 'PHP' | 'MWK', required — An ISO 4217 3-character code of the currency - `customerPaymentMethodId` string — The ID of the payment method of the subscription - `origin` object — The origin information of the subscription - `eventId` string, required — The ID of the event of the origin - `shopId` string — The ID of the shop of the origin - `items` SubscriptionItemResource[], required — The origin information of the subscription - `type` 'ticket' — The type of the cart item. - `_id` string — Unique identifier for the cart item. If omitted, the system will automatically generate one. - `name` string, nullable — The name of the cart item. - `amount` integer, required — The amount of the cart item. - `netPrice` number, float — The single piece net price of the cart item. - `price` number, float, required — The single piece price of the cart item. - `taxRate` number, float, nullable — The tax rate to be applied to this cart item. If not present the tax rate of the transaction is taken. - `triggeredBy` union — An ID or an array of IDs of other cart items which triggered the buy action of the cart item. - string — An ID of another cart item which triggered the buy action of the cart item. - string[] — An array of IDs of other cart items which triggered the buy action of the cart item. - `bundleInfo` object, nullable - `bundleId` string - `componentId` string - `optionId` string - `ticketTypeId` string, required — The ID of the ticket type of the cart item. - `categoryRef` string — The category reference of the ticket type. - `seatingInfo` object, nullable — The associated seating object. - `_id` string — The ID of the seating object. - `_type` 6 | 7, float, required — Indicates the type of seating object. Seat = 6, General Admission = 7. - `categoryId` string — The ID of the category containing the seating object. - `statusId` string, required — The ID of a container holding information about the seating status of the seating object. - `name` string, nullable — If _type == 7. The name of the general admission. - `seatType` 'handicapped' | 'limitedView' | 'foldable', nullable — If _type == 6. The type of the seat. null = normal. - `sectionName` string, nullable — If _type == 6. The name of the section where the seat is located. - `groupName` string, nullable — If _type == 6. The name of the row group where the seat is located. - `rowName` string, nullable — If _type == 6. The name of the row where the seat is located. - `seatName` string, nullable — If _type == 6. The seat name. - `gate` string, nullable — The entry gate associated with the seating object. - `slotInfo` object, nullable — The associated time slot object. - `slotId` string, required — The ID of the time slot. - `slotStartTime` string, required — The start time of the time slot. - `asHardTicket` boolean, nullable — Whether this ticket is a hard ticket. - `listingId` string, nullable — Listing in secondary market. - `listingItemId` string, nullable — The ID of the listing item in the secondary market. - `triggeredAutomations` boolean, nullable — Whether the cart item triggered automations. - `meta` object, nullable — Meta data which is propagated to the ticket. - `addOns` object[] — A list of Add-Ons of the ticket. - `productId` string, required - `productVariantId` string, required - `name` string, required - `capabilities` union[], nullable — The capabilities of the ticket. - union - object - `type` 'self_service_return', required - `settings` object, required - … - object - `type` 'repersonalization', required - `settings` object, required - … - `taxInfo` object — The tax info details. - `serviceTypeId` string — The ID of the service type. - `exceptionId` string — The ID of the exception. - `proceedsAccountId` string — The ID of the proceeds account. - `proceedsAccountCode` string — The code of the proceeds account. - `taxItems` object[] — The array of tax items. - `name` string, nullable - `taxTypeId` string, nullable - `rate` number, float, required - `perUnit` number, float, required - `total` number, float, required - `netTotal` number, float, nullable - `netPerUnit` number, float, nullable - `taxPayableAccountId` string, nullable - `taxPayableAccountCode` string, nullable - `ticketId` string, required — The ticket ID of the item - `planVariantId` string — The plan variant ID of the item - `billing` object — The billing information of the subscription - `cycles` object[], required — An array of billing cycles - `start` string, date-time, required — An ISO timestamp indicating when the billing start is - `end` string, date-time, required — An ISO timestamp indicating when the billing end is - `due` string, date-time — An ISO timestamp indicating when the billing due is - `status` 'FAILED' | 'SCHEDULED' | 'BILLED' | 'CANCELED', required — The status of the billing - `transactionId` string - `isMinimumInterval` boolean - `consents` object[] — An array of granted consents - `type` 'autorenewal', required — The type of the subscription consent - `granted` string, date-time, required — The date when the consent was granted - `payment` object — The payment of the subscription - `anchor` string, date-time, required — The anchor date of the payment - `schedules` object[], required - `due` string, date-time — An ISO timestamp indicating when the due of the payment schedule is - `status` 'SCHEDULED' | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'REFUNDED', required — The status of the payment schedule resource - `total` number, float, required — The total to be charged of the payment schedule - `billingCycleId` string, required — The Billing Cycle ID of the payment schedule - `paymentId` string — The Payment ID of the payment schedule - `paymentRequestId` string — The Payment Request ID of the payment schedule - `attempts` object[] — An array of payment schedule attempts - `_id` string, required — The ID of the payment schedule attempt - `date` string, date-time, required — The date of the payment schedule attempt - `status` 'SCHEDULED' | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'REFUNDED', required — The status of the payment schedule attempt - `paymentRequestId` string, required — The Payment Request ID of the payment schedule attempt - `paymentMethodId` string, required — The Payment Method ID of the payment schedule attempt - `nextAttempt` string, date-time — An ISO timestamp indicating when the next attempt of the payment schedule is - `cycles` object[] — An array of applied cycles on the subscription - `cycleId` string — The cycle ID of the applied cycle - `appliedAt` string, date-time — An ISO timestamp indicating when the cycle was applied - `history` object[] — An array of history items indicating changes on the subscription - `type` 'subscription.created' | 'subscription.status_changed' | 'subscription.cycle_applied' | 'subscription.cycle_failed' | 'subscription.billing_cycle_applied' | 'subscription.payment_method_changed' | 'subscription.item_changed' | 'subscription.item_deleted' | 'subscription.consent_granted' | 'subscription.consent_revoked' | 'subscription.upgraded' — The type of the history item - `date` string, date-time — An ISO timestamp indicating the date of the history item - `userId` string, nullable — The user ID if the history item comes from a non-subscription-holders - `data` object — The data of the history item - `transactionId` string — The ID of the transaction of the subscription - `startAt` string, date-time — An ISO timestamp indicating when the subscription starts - `cancelAt` string, date-time — An ISO timestamp indicating when the subscription cancels - `canceledAt` string, date-time — An ISO timestamp indicating when the subscription was canceled - `company` string — The company of the subscription holder - `firstname` string — The first name of the subscription holder - `lastname` string — The last name of the subscription holder - `name` string — The name of the subscription holder - `email` string, email — The email of the subscription holder - `phone` string, nullable — The phone number of the subscription holder - `address` object — The address information of the subscription holder - `fullAddress` string, nullable — Optional full address - `street` string, nullable — The street of the address. Street name including number. - `line2` string, nullable — The additional field of the address. - `postal` string, nullable — The postal code of the address. - `city` string, nullable — The city of the address. - `country` string, nullable — The country of the address. An ISO 3166 country code. - `state` string, nullable — The state of the address. If applicable - `secret` string, date-time — The secret token of the subscription - `attributes` object - `total` integer ## Other responses - `400` — Bad Request - `401` — Unauthorized --- [API](https://skmtc.net/vivenu/apis/vivenu-api.md) · [All operations](https://skmtc.net/vivenu/apis/vivenu-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vivenu/vivenu-api/revisions/36be0dca14e7/schema)