Create a pricing plan subscription group | Solvimon

curl -X POST https://test.api.solvimon.com/v1/pricing-plan-subscription-groups \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "reference": "6fb490a2-4186-4a83-af0e-4abb61effeb7",
  "name": "Customer1 combine",
  "description": "Pricing plan subscription group for customer 1",
  "owner_customer_id": "cust_awDeAl0tsKup9BBJNU1m"
}'

{
  "reference": "string",
  "object_type": "string",
  "id": "string",
  "name": "string",
  "description": "string",
  "owner_customer_id": "string",
  "owner_customer": {
    "reference": "string",
    "type": "ORGANIZATION",
    "email": "string",
    "roles": [
      "DEFAULT"
    ],
    "object_type": "string",
    "id": "string",
    "created_at": "string",
    "parent_customer_id": "string",
    "parent_customer_ids": [
      "string"
    ],
    "status": "DRAFT",
    "timezone": "string",
    "notification_preferences": [
      {
        "type": "INVOICE",
        "channels": [
          {
            "type": "EMAIL",
            "enabled": true
          }
        ]
      }
    ],
    "locale": "string",
    "individual": {
      "name": {
        "first_name": "string",
        "last_name": "string",
        "infix": "string"
      },
      "residential_address": {
        "line1": "string",
        "line2": "string",
        "city": "string",
        "postal_code": "string",
        "state": "string",
        "country": "AD"
      }
    },
    "organization": {
      "legal_name": "string",
      "tax_id": "string",
      "tax_ids": [
        {
          "id": "string",
          "type": "GENERIC_TAX_ID",
          "tax_id_validation_result": {
            "id": "string",
            "validation_date": "string",
            "source": "string",
            "valid": "VALID",
            "message": "string"
          }
        }
      ],
      "registration_number": "string",
      "tax_exempt": true,
      "tax_exempt_note": "string",
      "registered_address": {
        "line1": "string",
        "line2": "string",
        "city": "string",
        "postal_code": "string",
        "state": "string",
        "country": "AD"
      },
      "tax_registrations": [
        {
          "id": "string",
          "description": "string",
          "tax_id": "string",
          "tax_ids": [
            {
              "id": "string",
              "type": "GENERIC_TAX_ID",
              "tax_id_validation_result": {
                "id": "string",
                "validation_date": "string",
                "source": "string",
                "valid": "VALID",
                "message": "string"
              }
            }
          ],
          "registration_number": "string",
          "registered_address": {
            "line1": "string",
            "line2": "string",
            "city": "string",
            "postal_code": "string",
            "state": "string",
            "country": "AD"
          }
        }
      ]
    },
    "custom_fields": [
      {
        "id": "string",
        "reference": "string",
        "value": "string",
        "values": [
          "string"
        ],
        "integration_details": {
          "payment_gateway_variant": "ADYEN",
          "id": "string",
          "reference": "string",
          "adyen": {
            "recurring_detail_reference": "string"
          },
          "stripe": {
            "payment_method_id": "string"
          }
        }
      }
    ],
    "processing_only": true,
    "pricing_plan_subscription_selector": {
      "data": [
        {
          "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
          "value": "string"
        }
      ],
      "rules": [
        {
          "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
          "type": "EQUALS"
        }
      ],
      "filters": [
        {
          "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
          "type": "EQUALS",
          "value": "string"
        }
      ],
      "fallback": "LATEST"
    },
    "linked_integrations": [
      {
        "id": "string",
        "link_details": [
          {
            "url": "string",
            "custom_field_name": "string"
          }
        ]
      }
    ]
  },
  "pricing_plan_subscription_ids": [
    "string"
  ]
}

Requires the PRICING_PLAN_SUBSCRIPTION_GROUP.CREATE 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

Request

This endpoint expects an object.

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

Unique reference for this subscription group

namestring or nullOptional

Optional name for this subscription group

descriptionstring or nullOptional

Optional description for this subscription group

owner_customer_idstring or nullOptional

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 nullOptional

Response

Created

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

409

Conflict Error

500

Internal Server Error

1	{
2	"reference": "string",
3	"object_type": "string",
4	"id": "string",
5	"name": "string",
6	"description": "string",
7	"owner_customer_id": "string",
8	"owner_customer": {
9	"reference": "string",
10	"type": "ORGANIZATION",
11	"email": "string",
12	"roles": [
13	"DEFAULT"
14	],
15	"object_type": "string",
16	"id": "string",
17	"created_at": "string",
18	"parent_customer_id": "string",
19	"parent_customer_ids": [
20	"string"
21	],
22	"status": "DRAFT",
23	"timezone": "string",
24	"notification_preferences": [
25	{
26	"type": "INVOICE",
27	"channels": [
28	{
29	"type": "EMAIL",
30	"enabled": true
31	}
32	]
33	}
34	],
35	"locale": "string",
36	"individual": {
37	"name": {
38	"first_name": "string",
39	"last_name": "string",
40	"infix": "string"
41	},
42	"residential_address": {
43	"line1": "string",
44	"line2": "string",
45	"city": "string",
46	"postal_code": "string",
47	"state": "string",
48	"country": "AD"
49	}
50	},
51	"organization": {
52	"legal_name": "string",
53	"tax_id": "string",
54	"tax_ids": [
55	{
56	"id": "string",
57	"type": "GENERIC_TAX_ID",
58	"tax_id_validation_result": {
59	"id": "string",
60	"validation_date": "string",
61	"source": "string",
62	"valid": "VALID",
63	"message": "string"
64	}
65	}
66	],
67	"registration_number": "string",
68	"tax_exempt": true,
69	"tax_exempt_note": "string",
70	"registered_address": {
71	"line1": "string",
72	"line2": "string",
73	"city": "string",
74	"postal_code": "string",
75	"state": "string",
76	"country": "AD"
77	},
78	"tax_registrations": [
79	{
80	"id": "string",
81	"description": "string",
82	"tax_id": "string",
83	"tax_ids": [
84	{
85	"id": "string",
86	"type": "GENERIC_TAX_ID",
87	"tax_id_validation_result": {
88	"id": "string",
89	"validation_date": "string",
90	"source": "string",
91	"valid": "VALID",
92	"message": "string"
93	}
94	}
95	],
96	"registration_number": "string",
97	"registered_address": {
98	"line1": "string",
99	"line2": "string",
100	"city": "string",
101	"postal_code": "string",
102	"state": "string",
103	"country": "AD"
104	}
105	}
106	]
107	},
108	"custom_fields": [
109	{
110	"id": "string",
111	"reference": "string",
112	"value": "string",
113	"values": [
114	"string"
115	],
116	"integration_details": {
117	"payment_gateway_variant": "ADYEN",
118	"id": "string",
119	"reference": "string",
120	"adyen": {
121	"recurring_detail_reference": "string"
122	},
123	"stripe": {
124	"payment_method_id": "string"
125	}
126	}
127	}
128	],
129	"processing_only": true,
130	"pricing_plan_subscription_selector": {
131	"data": [
132	{
133	"field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
134	"value": "string"
135	}
136	],
137	"rules": [
138	{
139	"field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
140	"type": "EQUALS"
141	}
142	],
143	"filters": [
144	{
145	"field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
146	"type": "EQUALS",
147	"value": "string"
148	}
149	],
150	"fallback": "LATEST"
151	},
152	"linked_integrations": [
153	{
154	"id": "string",
155	"link_details": [
156	{
157	"url": "string",
158	"custom_field_name": "string"
159	}
160	]
161	}
162	]
163	},
164	"pricing_plan_subscription_ids": [
165	"string"
166	]
167	}

Authentication

Path parameters

Headers

Request

Response

Errors