| Required role: | Backoffice |
| GET | /subscription/get |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BusinessId | query | long | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Subscriptions | form | List<SubscriptionDto> | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| BusinessId | form | long | No | |
| SubscriptionPlanId | form | long | No | |
| SubscriptionDetails | form | SubscriptionDetailsUnion | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FreeUntil | form | SubscriptionDetailsFreeUntil | No | |
| Invoice | form | SubscriptionDetailsInvoice | No | |
| Stripe | form | SubscriptionDetailsStripe | No | |
| FreeOnClaim | form | SubscriptionDetailsFreeOnClaim | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StripeX | form | string | No | |
| CardExpiresAtMonth | form | int | No | |
| CardExpiresAtYear | form | int | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /subscription/get HTTP/1.1 Host: backoffice-api.brovs.com Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"subscriptions":[{"id":0,"businessId":0,"subscriptionPlanId":0,"subscriptionDetails":{"freeUntil":{},"invoice":{},"stripe":{"stripeX":"String","cardExpiresAtMonth":0,"cardExpiresAtYear":0},"freeOnClaim":{}}}]}