Create Subscription Group

Creates a subscription group with optional nested subscriptions for a project.

GETPOST

Authentication

Requirement: Required
Credential type: Bearer API key
Scopes: Not specified

Permissions

Requests are scoped to the target project_id. API-key requests must use a key with an active connection to that project.

Headers

Name	Required	Type	Details
`Authorization`	Yes	Not specified	Description: Bearer credential used to authenticate the request.

Path Parameters

Name	Required	Type	Details
`project_id`	Yes	Not specified	Description: Target project identifier.

Query Parameters

This operation does not accept query parameters.

Request Body

Schema: SubscriptionGroupPayload

Field	Required	Type	Details
`name`	Yes	string	Description: Display name.
`discount_type`	No	string	Description: Text value.
`discount_amount`	No	JSON	Description: Numeric amount.
`discount_scope`	No	string	Description: Text value.
`intro_duration`	No	integer	Description: Integer value.
`intro_unit`	No	string	Description: Text value.
`discount_target`	No	string	Description: Text value.
`tax_enabled`	No	boolean	Description: Boolean flag.
`require_payment_before_trial`	No	boolean	Description: Boolean flag.
`refund_policy`	No	JSON	Description: JSON object.
`upgrade_allowed`	No	boolean	Description: Boolean flag.
`upgrade_charge_model`	No	string	Description: Text value.
`upgrade_proration_window_days`	No	integer	Description: Integer value.
`downgrade_allowed`	No	boolean	Description: Boolean flag.
`downgrade_apply`	No	string	Description: Text value.
`allow_multiple_subscriptions`	No	boolean	Description: Boolean flag.
`subscriptions`	No	array<SubscriptionPayload>	Description: Array value. Items: SubscriptionPayload

Response Body

Example 200 response

json

{
  "error": "string",
  "success": [],
  "id": 1
}

Errors

Operation-specific error responses are not available in the current release metadata.

Availability

Available in: v0.1.0
Available since: v0.1.0
Implementation: Available
Deprecation: Not specified
Rate limits: Not specified

Example request

POST/api/projects/{project_id}/sales/subscription_groups

Base URLhttps://api.modusell.com

curl --request POST \
  --url "https://api.modusell.com/api/projects/example_project_id/sales/subscription_groups" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"name":"VALUE","discount_type":"VALUE","discount_amount":{},"discount_scope":"VALUE","intro_duration":1,"intro_unit":"VALUE","discount_target":"VALUE","tax_enabled":true,"require_payment_before_trial":true,"refund_policy":{},"upgrade_allowed":true,"upgrade_charge_model":"VALUE","upgrade_proration_window_days":1,"downgrade_allowed":true,"downgrade_apply":"VALUE","allow_multiple_subscriptions":true,"subscriptions":[]}'

Response

Examples are not available for this release.

Authentication

Required: Bearer API key.