Create a subscription

POST

/user/{userId}/subscription

curl --request POST \
  --url https://client-api.abi.ai/user/abi1234/subscription \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "startDate": "2021-11-17", "endDate": "2022-05-31", "shouldNotify": true, "productName": "Free trial" }'

• Abi Client API

Authorizations

• bearerAuth

Parameters

Path Parameters

userId

required

string

The Abi identifier of the user account.

Example

abi1234

Request Body^required

Media typeapplication/json

object

startDate

required

The UTC date on which the subscription becomes active.

string format: date

Example

2021-11-17

endDate

The UTC date on which the subscription expires.

string format: date

Example

2022-05-31

shouldNotify

Send the configured invitation notification when contact details are available.

boolean

default: true

Example

true

productName

The Abi-provided product identifier for this subscription.

string

Example

Free trial

Responses

201

Subscription created. See the Subscription model for field definitions.

Media typeapplication/json

object

Example

{
  "user": {
    "id": "abi1234",
    "uniqueId": "123abc789xyz",
    "userStatus": "activeUser",
    "firstName": "Jane",
    "lastName": "Doe",
    "email": "janedoe@gmail.com",
    "gender": "female",
    "phone": "+441234567890",
    "origin": "gb",
    "location": "es",
    "country": "it",
    "physicianCountry": "es",
    "language": "en",
    "dateOfBirth": "1994-10-07",
    "partnerName": "Abi",
    "associatedAccounts": 5
  },
  "subscription": {
    "subscriptionId": "8910zyx321cba",
    "userId": "abi1234",
    "startSubscription": "2021-11-17T00:00:00.000Z",
    "endSubscription": "2022-05-31T00:00:00.000Z",
    "active": 1,
    "createdAt": "2021-11-17T00:00:00.000Z",
    "canceledAt": null,
    "shouldNotify": true,
    "productName": "Free trial",
    "renewFrom": null
  }
}

400

Request could not be completed.

Media typeapplication/json

object

code

Short machine-readable error code.

string

message

Human-readable explanation of the error.

string

Example^generated

{
  "code": "example",
  "message": "example"
}

404

Request could not be completed.

Media typeapplication/json

object

code

Short machine-readable error code.

string

message

Human-readable explanation of the error.

string

Example^generated

{
  "code": "example",
  "message": "example"
}