Delete a pricing plan subscription group by its ID | Solvimon

curl -X DELETE https://test.api.solvimon.com/v1/pricing-plan-subscription-groups/ \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "reference": "PPSG-2024-0001",
  "object_type": "pricing_plan_subscription_group",
  "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
  "name": "Enterprise Subscription Group",
  "description": "Group for enterprise-level pricing plan subscriptions",
  "owner_customer_id": "cust-987654321",
  "owner_customer": {
    "reference": "ORG-ENT-001",
    "type": "ORGANIZATION",
    "email": "contact@enterpriseexample.com",
    "roles": [
      "DEFAULT",
      "ADMIN"
    ],
    "object_type": "customer",
    "id": "cust-987654321",
    "created_at": "2023-11-15T09:45:00Z",
    "parent_customer_id": "cust-123456789",
    "parent_customer_ids": [
      "cust-123456789",
      "cust-000111222"
    ],
    "status": "ACTIVE",
    "timezone": "America/New_York",
    "notification_preferences": [
      {
        "type": "INVOICE",
        "channels": [
          {
            "type": "EMAIL",
            "enabled": true
          }
        ]
      }
    ],
    "locale": "en-US",
    "individual": {
      "name": {
        "first_name": "John",
        "last_name": "Doe",
        "infix": ""
      },
      "residential_address": {
        "line1": "123 Maple Street",
        "line2": "Suite 400",
        "city": "New York",
        "postal_code": "10001",
        "state": "NY",
        "country": "US"
      }
    },
    "organization": {
      "legal_name": "Enterprise Solutions Inc.",
      "tax_id": "98-7654321",
      "tax_ids": [
        {
          "id": "98-7654321",
          "type": "EIN"
        }
      ],
      "registration_number": "REG-2023-4567",
      "tax_exempt": false,
      "tax_exempt_note": "",
      "registered_address": {
        "line1": "500 Corporate Blvd",
        "line2": "Floor 10",
        "city": "New York",
        "postal_code": "10022",
        "state": "NY",
        "country": "US"
      }
    },
    "custom_fields": [
      {
        "id": "cf-001",
        "reference": "preferred_payment_gateway",
        "value": "stripe",
        "values": [
          "stripe",
          "adyen"
        ],
        "integration_details": {
          "payment_gateway_variant": "STRIPE",
          "id": "int-123",
          "reference": "stripe_main_account",
          "adyen": {
            "recurring_detail_reference": ""
          },
          "stripe": {
            "payment_method_id": "pm_1GqIC8Lz0qyl6XeW3xYz1234"
          }
        }
      }
    ],
    "processing_only": false,
    "pricing_plan_subscription_selector": {
      "data": [
        {
          "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
          "value": "US"
        }
      ],
      "rules": [
        {
          "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
          "type": "EQUALS"
        }
      ],
      "filters": [
        {
          "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
          "type": "EQUALS",
          "value": "US"
        }
      ],
      "fallback": "LATEST"
    },
    "linked_integrations": [
      {
        "id": "int-456",
        "link_details": [
          {
            "url": "https://dashboard.stripe.com/account",
            "custom_field_name": "Stripe Dashboard"
          }
        ]
      }
    ]
  },
  "pricing_plan_subscription_ids": [
    "sub-00123456789",
    "sub-00987654321"
  ]
}

Requires the PRICING_PLAN_SUBSCRIPTION_GROUP.DELETE permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1

version

resourceIdstringRequiredDefaults to

The ID of the resource to be requested.

Response

referencestringformat: "^\S+$"0-256 characters

Unique reference for this subscription group

object_typestring or nullRead-only

idstring or nullRead-only

namestring or null

Optional name for this subscription group

descriptionstring or null

Optional description for this subscription group

owner_customer_idstring or null

When provided, this subscription group can only be used for the customer that is linked to this ID and children of that customer

owner_customerobject or null

pricing_plan_subscription_idslist of strings or nullRead-only

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors