Update Objects

APIs related to updating Limio Objects

Update Object

put

This API allows you to update objects in Limio. You can update a subscription, customer, order, identity, address, schedule, payment method, subscription offer, promo code, or user entitlement. It is designed to be flexible and allow you to update any field in the object.

Authorizations

bearerAuth

AuthorizationstringRequired

To create a Bearer token, see How to get an OAuth Bearer Token?.

Usage format: Bearer <token>

Path parameters

servicestring · enumRequired

The service the object belongs to

Default: limioPossible values:

path_typestring · enumRequiredPossible values:

idstringRequiredExample: sub-abcxyz123456

Body

application/json

namestringOptional

The object name such as the subscription name, or gift code name. Not included values will not be updated and nested values will require the structure to update. Updates will only occur for the id provided. WARNING! Changing this field might break integrations

Example: abc123

dataone ofRequired

or

or

Responses

200

OK

application/json

idstringOptional

The ID of the object

Example: sub-123123123

sort_keystringOptional

The sort key of the object

Example: object/subscription

dataobjectOptional

The data of the object sent in the request

Example: {"quantity":2}

400

Bad request (missing required fields)

401

Unauthorized

application/json

404

Not found

put

/objects/{service}/{path_type}/{id}

HTTPcURLJavaScriptPython

PUT /api/objects/{service}/{path_type}/{id} HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "name": "abc123",
  "data": {
    "quantity": 2
  }
}

{
  "id": "sub-123123123",
  "sort_key": "object/subscription",
  "data": {
    "quantity": 2
  }
}

Delete Object

delete

This API allows you to delete objects in Limio. Currently, only promo codes v2 are deleted via this API.

Authorizations

bearerAuth

AuthorizationstringRequired

To create a Bearer token, see How to get an OAuth Bearer Token?.

Usage format: Bearer <token>

Path parameters

servicestring · enumRequired

The service the object belongs to

Default: limioPossible values:

path_typestring · enumRequiredPossible values:

idstringRequiredExample: sub-abcxyz123456

Responses

200

OK

application/json

httpStatusCodeintegerOptional

The HTTP status code of the response

Example: 200

requestIdstringOptional

The request ID

Example: 1234ABC

attemptsintegerOptional

The number of attempts made

Example: 1

totalRetryDelayintegerOptional

The total retry delay in milliseconds

Example: 0

401

Unauthorized

application/json

404

Not found

502

Bad Gateway

application/json

delete

/objects/{service}/{path_type}/{id}

HTTPcURLJavaScriptPython

DELETE /api/objects/{service}/{path_type}/{id} HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "httpStatusCode": 200,
  "requestId": "1234ABC",
  "attempts": 1,
  "totalRetryDelay": 0
}

Add Object Relationship

post

This API allows you to add a related identity object to a specific object of provided path type from a provided service using the object's ID. You can add related objects of a subscription, customer, order, identity, address, schedule, payment method, subscription offer, or user entitlement.

Required scopes

This endpoint requires the following scopes:

Authorizations

bearerAuth

AuthorizationstringRequired

To create a Bearer token, see How to get an OAuth Bearer Token?.

Usage format: Bearer <token>

Path parameters

servicestring · enumRequired

The service the object belongs to

Default: limioPossible values:

idstringRequiredExample: sub-abcxyz123456

path_typestring · enumRequiredPossible values:

record_typestringRequired

Only identity is allowed

Default: identity

Body

application/json

Related Object Request

idstringOptional

The identity to which you want to link the object to

Example: identity-bcc1997b17b7824caf86b06451904fb8

servicestring · enumOptional

The service of the identity

Example: limioPossible values:

Responses

200

OK

application/json

nullOptional

401

Unauthorized

application/json

502

Bad Gateway

application/json

post

/objects/{service}/{path_type}/{id}/related/{record_type}

HTTPcURLJavaScriptPython

POST /api/objects/{service}/{path_type}/{id}/related/{record_type} HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "id": "identity-bcc1997b17b7824caf86b06451904fb8",
  "service": "limio"
}

No content