Metadata Fields
Many Subscribe Pro API endpoints accept a common set of metadata fields. Generally the metadata fields are passed in a _meta field or key in support API requests.
NOTE: See the documentation for each specific API endpoint to confirm if the endpoint supports metadata fields.
All Metadata Fields
All possible metadata fields which may be passed in Subscribe Pro API requests.
| Property | Details |
|---|---|
| changed_by object | Details about the customer, user or other agent who is making the change represented by the associated API request. |
| order_details object | Details about an eCommerce order which is associated with subscription(s) referenced in this API request. This field is used to pass order details to Subscribe Pro when a customer signs up for a new subscription item via the eCommerce checkout on a connected eCommerce store. See: Order Details Data Definition |
Field Reference
Field _meta.changed_by.customer
Details about the customer who is making the change represented by this request.
| Property | Details |
|---|---|
| _meta.changed_by.customer.customer_id string | Subscribe Pro customer ID. |
| _meta.changed_by.customer.email string | Customer email address |
| _meta.changed_by.customer.full_name string | Customer full name. |
Field _meta.changed_by.admin
Details about the admin user who is making the change represented by this request.
| Property | Details |
|---|---|
| _meta.changed_by.admin.user_id string | User ID of the user who is making this change. This may be a unique user ID for the the admin user in the merchant's eCommerce platform or another external system. |
| _meta.changed_by.admin.email string | Admin user's email address. |
| _meta.changed_by.admin.full_name string | Admin user's full name. |