Skip to navigation
API ReferencePayer GroupsV1

Create a payer group

Beta

Create a payer group. When payer_plan_group_ids is provided, moves those plans into the new group atomically (same transaction). On any failure the group is not created and no plans are moved.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Request

This endpoint expects an object.
namestringRequired
payer_plan_group_idsset of UUIDsOptional

An optional set of payer plan group IDs to move into the new group in the same transaction. Omitting this field or passing an empty set behaves exactly like the existing create (an empty group is created).

Response

This endpoint returns an object.
namestring
payer_group_idUUID
payer_plan_group_countinteger

Errors

403
Unauthorized Error
404
Entity Not Found Error
409
Entity Conflict Error
422
Unprocessable Entity Error