Create a payer plan group

POST

/api/payer-plan-groups/v1

POST

/api/payer-plan-groups/v1

1 import uuid
2 
3 from candid import CandidApiClient
4 from candid.resources.commons import SourceOfPaymentCode
5 from candid.resources.payer_plan_groups.resources.v_1 import (
6     MutablePayerPlanGroup,
7 )
8 
9 client = CandidApiClient(
10     client_id="YOUR_CLIENT_ID",
11     client_secret="YOUR_CLIENT_SECRET",
12 )
13 client.payer_plan_groups.v_1.create(
14     request=MutablePayerPlanGroup(
15         plan_group_name="string",
16         payer_uuid=uuid.UUID(
17             "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
18         ),
19         plan_type=SourceOfPaymentCode.SELF_PAY,
20     ),
21 )

Try it

200Successful

1 {
2   "is_active": true,
3   "payer": {
4     "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
5     "payer_id": "string",
6     "payer_name": "string",
7     "availity_payer_name": "string",
8     "availity_claims_payer_id": "string",
9     "availity_eligibility_id": "string",
10     "availity_remittance_payer_id": "string",
11     "street_address": {
12       "address1": "string",
13       "city": "string",
14       "state": "AA",
15       "zip_code": "string",
16       "zip_plus_four_code": "string",
17       "address2": "string"
18     }
19   },
20   "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
21   "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
22   "plan_group_name": "string",
23   "plan_type": "09"
24 }

Create a payer plan group

Request

This endpoint expects an object.

plan_group_namestringRequired

payer_uuidUUIDRequired

plan_typeenumRequired

Response

This endpoint returns an object.

is_activeboolean

payerobject

payer_plan_group_idUUID

payer_uuidUUID

plan_group_namestring

plan_typeenum

Create a payer plan group

Headers

Request

Response

Errors