Maxio Advanced Billing
HomeSDKsAPI ReferenceContext Plugin
Custom Fields

Delete Metadata

DELETE
/{resource_type}/{resource_id}/metadata.json

Deletes one or more metafields (and associated metadata) from the specified subscription or customer.

Authorization

BasicAuth
AuthorizationBasic <token>

The username is a Maxio Chargify API key. The password is x.

In: header

Path Parameters

resource_type*Resource Type

The resource type to which the metafields belong.

Value in

  • "subscriptions"
  • "customers"
resource_id*integer

The Advanced Billing id of the customer or the subscription for which the metadata applies

Query Parameters

name?string

Name of field to be removed.

names?array<string>

Names of fields to be removed. Use in query: names[]=field1&names[]=my-field&names[]=another-field.

Response Body

curl -X DELETE "https://example.com/subscriptions/0/metadata.json"
Empty

Create Metadata POST

Creates metadata and metafields for a specific subscription or customer, or updates metadata values of existing metafields for a subscription or customer. Metadata values are limited to 2 KB in size. If you create metadata on a subscription or customer with a metafield that does not already exist, the metafield is created with the metadata you specify and it is always added as a text field. You can update the input_type for the metafield with the [Update Metafield](https://maxio-test-wp.pages.dev/api/openapi/custom-fields/updateMetafield) endpoint. >Note: Each site is limited to 100 unique metafields per resource. This means you can have 100 metafields for Subscriptions and another 100 for Customers.

Update Metadata PUT

Updates metadata and metafields on the Site and the customer or subscription specified, and updates the metadata value on a subscription or customer. If you update metadata on a subscription or customer with a metafield that does not already exist, the metafield is created with the metadata you specify and it is always added as a text field to the Site and to the subscription or customer you specify. You can update the input_type for the metafield with the Update Metafield endpoint. Each site is limited to 100 unique metafields per resource. This means you can have 100 metafields for the Subscription resource and another 100 for the Customer resource.