confirmPurchase

v1.0.0

Confirms purchase and returns the details of purchased subscription for specified payment platform.

Input

{
  "type": "object",
  "properties": {
    "cardToken": {
      "type": "string",
      "description": "The credit card token."
    },
    "lang": {
      "type": "string"
    },
    "planId": {
      "type": "string",
      "description": "The identifier of the plan to purchase."
    },
    "platform": {
      "type": "string"
    },
    "profileToken": {
      "type": "string",
      "description": "The ITV profile token."
    },
    "voucher": {
      "type": "string",
      "description": "A coupon/voucher for a discount."
    }
  },
  "required": [
    "cardToken",
    "planId",
    "platform",
    "profileToken"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "planId"
  ],
  "properties": {
    "customerId": {
      "type": "string",
      "description": "The identifier of user in payment system."
    },
    "planId": {
      "type": "string",
      "description": "The identifier of subscription plan."
    },
    "subscriptionId": {
      "type": "string",
      "description": "The identifier of subscription in payment system."
    }
  },
  "additionalProperties": false
}