Rebilly API Docs

Upsert a custom cashier property set

Creates or updates (upserts) a custom cashier property set with a specified ID.

SecuritySecretApiKey or JWT

Request

path Parameters

required

string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

Request Body schema: application/json

Custom cashier property set resource.

name required	string Name of the custom property set.
properties required	object Defines properties the user can complete when they use the hosted cashier form. This field accepts JSON-schema drafts 4, 6, and 7. Accepted properties types are: `string`, `number`, `integer`, `array`, and `enum`. For more information, see Configure custom hosted cashier properties.

Responses

200

Custom cashier property updated.

Response Schema: application/json

name required	string Name of the custom property set.
properties required	object Defines properties the user can complete when they use the hosted cashier form. This field accepts JSON-schema drafts 4, 6, and 7. Accepted properties types are: `string`, `number`, `integer`, `array`, and `enum`. For more information, see Configure custom hosted cashier properties.
id	string <= 50 characters ID of the cashier property set.

201

Custom cashier property set created.

Response Headers
Location	string <uri> Location of the related resource. Example: "https://api.rebilly.com/example"

Response Schema: application/json

name required	string Name of the custom property set.
properties required	object Defines properties the user can complete when they use the hosted cashier form. This field accepts JSON-schema drafts 4, 6, and 7. Accepted properties types are: `string`, `number`, `integer`, `array`, and `enum`. For more information, see Configure custom hosted cashier properties.
id	string <= 50 characters ID of the cashier property set.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

409

Conflict.

422

Invalid data sent.

put/cashier-custom-property-sets/{id}

Request samples

application/json

{"name": "string",
"properties": {"type": "object",
"properties": {"email": {"type": "string"
},
"max": {"type": "integer",
"minimum": 0,
"exclusiveMaximum": 100
}
},
"required": ["email"
]
}
}

Response samples

application/json

{"id": "cash_prop_0YVJ640MB4CXVB8KXBRW3B79R9",
"name": "string",
"properties": {"type": "object",
"properties": {"email": {"type": "string"
},
"max": {"type": "integer",
"minimum": 0,
"exclusiveMaximum": 100
}
},
"required": ["email"
]
}
}

➔ Next to Delete a custom cashier property set