Skip to content
Reference
/
/
Update subscription statu...

Update subscription status

Request

Updates the status of a subscription (ACTIVE or PAUSED)

Security
oauth2ClientCredentials(Required scopes: subscriptions:write)
Query
subscription_idstringrequired

Subscription ID

Example:subscription_id=67b44aea86c1ccabbe965827
Headers
org_wallet_refstring

Organization wallet reference, defaults to "1" if not provided

business_idstringrequired

Business identifier for the request

Bodyapplication/jsonrequired
statusstringrequired

Subscription status

Enum:"ACTIVE""PAUSED"
Example:"ACTIVE"
curl -i -X PUT \
  'https://developer.boyahq.com/_mock/v2/openapi/subscriptions/status?subscription_id=67b44aea86c1ccabbe965827' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'business_id: string' \
  -H 'org_wallet_ref: string' \
  -d '{
    "status": "ACTIVE"
  }'

Responses

Updated subscription

Bodyapplication/json
_idstring

Subscription ID

businessobject(SubscriptionBusinessDto)

Business information

namestring

Subscription name

limitnumber

Subscription limit

cardsArray of objects(SubscriptionCardDto)

Associated cards

assigneeobject(SubscriptionAssigneeDto)

Subscription assignee

statusstring

Subscription status

Enum:"DRAFT""ACTIVE""PAUSED""REJECTED""DELETED""PENDING"
Example:"ACTIVE"
wallet_idstring

Wallet ID

wallet_currencystring

Wallet currency

frequency_period_unitstring

Frequency period unit

frequencynumber

Frequency

iconstring

Subscription icon URL

merchant_category_codestring

Merchant category code

merchant_receiver_namestring

Merchant receiver name

amount_spentnumber

Amount spent

last_transacted_amountnumber

Last transacted amount

scorenumber

Score

next_invoice_datestring

Next invoice date

createdAtstring

Created date

updatedAtstring

Updated date

subcategoryobject(SubscriptionSubcategoryDto)

Subcategory information

teamobject(SubscriptionTeamDto)

Subcategory information

Response
{
  "_id": "string",
  "business": {
    "_id": "string",
    "name": "string",
    "email": "string",
    "phone": "string",
    "country": "string"
  },
  "name": "string",
  "limit": 0,
  "cards": [
    { … }
  ],
  "assignee": {
    "_id": "string",
    "name": "string",
    "employee_id": "string",
    "team_code": "string"
  },
  "status": "ACTIVE",
  "wallet_id": "string",
  "wallet_currency": "string",
  "frequency_period_unit": "string",
  "frequency": 0,
  "icon": "string",
  "merchant_category_code": "string",
  "merchant_receiver_name": "string",
  "amount_spent": 0,
  "last_transacted_amount": 0,
  "score": 0,
  "next_invoice_date": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "subcategory": {
    "_id": "string",
    "code": "string",
    "name": "string"
  },
  "team": {
    "code": "string",
    "name": "string"
  }
}