Create an add-on purchase for the namespace

Deprecated

POST

/api/v4/namespaces/{id}/subscription_add_on_purchase/{add_on_name}

• GitLab REST API

Deprecated in GitLab 17.7

Authorizations

• http
• oauth2

Parameters

Path Parameters

id

required

One of:

string

string

integer

integer

The ID or URL-encoded path of the namespace

add_on_name

required

string

The name of the add-on

Request Body ^required

Media type application/json

object

quantity

required

The quantity of the purchase

integer

nullable

started_on

required

The date when purchase takes effect

string format: date

nullable

expires_on

required

The date when purchase expires on

string format: date

nullable

purchase_xid

required

The purchase identifier (example: the subscription name)

string

nullable

trial

Whether the add-on is a trial

boolean

nullable

Example ^generated

{
  "quantity": 1,
  "started_on": "2026-04-15",
  "expires_on": "2026-04-15",
  "purchase_xid": "example",
  "trial": true
}

Responses

201

Created

Media type application/json

object

namespace_id

integer format: int64

namespace_name

string

add_on

string

quantity

integer

started_on

string format: date

expires_on

string format: date

purchase_xid

string

trial

boolean

Example

{
  "namespace_id": 123,
  "namespace_name": "GitLab",
  "add_on": "Code Suggestions",
  "quantity": 10,
  "started_on": "2023-05-30",
  "expires_on": "2023-05-30",
  "purchase_xid": "A-S00000001",
  "trial": false
}

400

Bad request

401

Unauthorized

404

Not found