Storefront custom fields

Use these operations to access Storefront custom fields.

Storefront operations interact directly with the customer, and provide the customer with access to their own data.

To use Storefront operations, the customer must be issued a JWT with limited permissions. For more information, see Create a session with username and password and Exchange an authentication token. Storefront operations are intended to be used directly from an untrusted browser.

Operations

Retrieve custom fields

Request

Retrieves the custom fields schema for a specified resource.

Security
CustomerJWT
Path
resourcestringrequired

Type of resource schema.

Enum:"customers""payment-instruments""subscriptions""transactions"
Query
limitinteger, [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offsetinteger, [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/storefront/custom-fields/{resource}?limit=1000&offset=1000' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Schema of custom fields retrieved.

Bodyapplication/json
Array [
namestringread-only

Name of the custom field.

typestringrequired

Describes the data type. The custom field type value cannot be changed.

Array of strings with up to 255 characters. The maximum size is 1000 elements.

Value:"array"
Discriminator
descriptionstring or null

Description of the custom field.

isEnabledboolean

Specifies if the custom field is enabled.

Default:true
additionalSchemaobject or null

Additional schema which adds additional values constrains.

]
Response
[
  {
    "name": "string",
    "type": "array",
    "description": "string",
    "isEnabled": true,
    "additionalSchema": { … },
    "_links": [ … ]
  }
]