Current product subscription
GET/v1/subscriptions/{product}
Returns the live subscription state for Woyra Mail or Email API. Requires billing:read.
Parameters
| Name | In | Description |
|---|---|---|
| productrequired | path |
Example
curl https://api.woyra.io/v1/subscriptions/<product> \
-H "Authorization: Bearer $WOYRA_KEY"Response
200 Current subscription.
| Field | Type | Description |
|---|---|---|
| object | "subscription" | |
| id | string | |
| product | string | |
| plan | string | |
| status | string | One of pending, active, past_due, cancelled, incomplete. |
| provider_customer_id | string | |
| provider_subscription_id | string | |
| current_period_end | timestamp |
Errors
| Status | Codes |
|---|---|
| 404 | not_found, product_not_offered |
Also in Billing
- POST /v1/topups — Add funds by card
- GET /v1/topups/{id} — One top-up
- POST /v1/subscriptions — Start a product subscription
- POST /v1/payments/stripe/webhook — Stripe's webhook
- GET /v1/ledger — The account statement
- GET /v1/billing/payment_options — How this account can pay
- PUT /v1/billing/payment_currency — Choose to pay in birr or in US dollars
- GET /v1/billing/bank_deposits — Recent birr bank deposits
- POST /v1/billing/bank_deposits — Request a birr bank deposit
- POST /v1/billing/bank_deposits/{id}/receipt — Upload the bank receipt for a deposit
- POST /v1/billing/bank_deposits/{id}/cancel — Cancel a deposit that has not been submitted or was returned
- GET /v1/balance — Retrieve account balance
- GET /v1/billing/email_tariff — The email price this account pays
- GET /v1/billing/email_subscription — This account's monthly email plan
- PUT /v1/billing/email_subscription — Take an email plan, or change it
- POST /v1/billing/email_subscription/cancel — Stop the email plan renewing
- GET /v1/pricing/email — The published email tariff