Subscriptions

Create subscription

post

https://emea.gsc.verifone.cloud/oidc/paypal-ecomhttps://us.gsc.verifone.cloud/oidc/paypal-ecomhttps://nz.gsc.verifone.cloud/oidc/paypal-ecomhttps://cst.test-gsc.vfims.com/oidc/paypal-ecomhttps://uscst.gb.gsc.cficloud/oidc/paypal-ecom

/subscriptions

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

x-vfi-api-idempotencyKeystringOptional

A value you specify that uniquely identifies the transaction. If you're unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about duplicating the transaction.

Body

*/*

paymentProviderContractstringRequired

PayPal Payment Provider Contract UUID

planIdstring · min: 3 · max: 50Required

The ID of the plan

startTimestring · dateOptional

The date and time when the subscription started

quantityintegerOptional

The quantity of the product in the subscription

customIdstring · min: 1 · max: 127Optional

The custom id for the subscription. Can be invoice id

Pattern: ^[ -~]+

Responses

201

Created

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post

/subscriptions

HTTPcURLJavaScriptPython

POST /oidc/paypal-ecom/subscriptions HTTP/1.1
Host: emea.gsc.verifone.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: */*
Accept: */*
Content-Length: 737

{
  "paymentProviderContract": "text",
  "planId": "text",
  "startTime": "2026-06-07",
  "quantity": 1,
  "shippingAmount": {
    "value": 100,
    "currencyCode": "EUR"
  },
  "subscriber": {
    "name": {
      "givenName": "text",
      "surname": "text"
    },
    "payerId": "text",
    "emailAddress": "text",
    "phone": {
      "phoneType": "FAX",
      "phoneNumber": {
        "nationalNumber": "text"
      }
    },
    "shippingAddress": {
      "name": {
        "fullName": "text"
      },
      "address": {
        "country": "text",
        "postalCode": "text",
        "countrySubdivision": "text",
        "city": "text",
        "addressLine2": "text",
        "addressLine1": "text"
      }
    }
  },
  "customId": "text",
  "applicationContext": {
    "brandName": "text",
    "locale": "text",
    "shippingPreference": "GET_FROM_FILE",
    "userAction": "CONTINUE",
    "paymentMethod": {
      "payerSelected": "text",
      "payeePreferred": "UNRESTRICTED"
    },
    "returnUrl": "text",
    "cancelUrl": "text"
  }
}

{
  "id": "text",
  "status": "text",
  "planId": "text",
  "statusUpdateTime": "2026-06-07",
  "planOverridden": true,
  "quantity": "text",
  "startTime": "2026-06-07",
  "shippingAmount": {
    "value": 100,
    "currencyCode": "EUR"
  },
  "subscriber": {
    "name": {
      "givenName": "text",
      "surname": "text"
    },
    "payerId": "text",
    "emailAddress": "text",
    "phone": {
      "phoneType": "FAX",
      "phoneNumber": {
        "nationalNumber": "text"
      }
    },
    "shippingAddress": {
      "name": {
        "fullName": "text"
      },
      "address": {
        "country": "text",
        "postalCode": "text",
        "countrySubdivision": "text",
        "city": "text",
        "addressLine2": "text",
        "addressLine1": "text"
      }
    }
  },
  "applicationContext": {
    "brandName": "text",
    "locale": "text",
    "shippingPreference": "GET_FROM_FILE",
    "userAction": "CONTINUE",
    "paymentMethod": {
      "payerSelected": "text",
      "payeePreferred": "UNRESTRICTED"
    },
    "returnUrl": "text",
    "cancelUrl": "text"
  },
  "createdAt": "2026-06-07",
  "approvalUrl": "text"
}

Subscription Details

get

https://emea.gsc.verifone.cloud/oidc/paypal-ecomhttps://us.gsc.verifone.cloud/oidc/paypal-ecomhttps://nz.gsc.verifone.cloud/oidc/paypal-ecomhttps://cst.test-gsc.vfims.com/oidc/paypal-ecomhttps://uscst.gb.gsc.cficloud/oidc/paypal-ecom

/subscriptions/{id}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Query parameters

paymentProviderContractstringRequired

PayPal Payment Provider Contract UUID

Responses

200

Successful

application/json

idstringOptional

ID of the subscription

statusstring · enumOptional

The status of the subscription

Possible values:

planIdstring · min: 3 · max: 50Required

The ID of the plan

planOverriddenbooleanOptional

Indicates whether the subscription has overridden any plan attributes

statusUpdateTimestring · dateOptional

The date and time when the subscription status updated last time

statusChangeNotestringOptional

The reason or notes for the status of the subscription

startTimestring · dateOptional

The date and time when the subscription started

quantityintegerOptional

The quantity of the product in the subscription

customIdstring · min: 1 · max: 127Optional

The custom id for the subscription. Can be invoice id

Pattern: ^[ -~]+

createdAtstring · dateOptional

The date and time when the subscription created

updatedAtstring · dateOptional

The date and time when the subscription updated last time

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/subscriptions/{id}

HTTPcURLJavaScriptPython

GET /oidc/paypal-ecom/subscriptions/{id}?paymentProviderContract=text HTTP/1.1
Host: emea.gsc.verifone.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "status": "APPROVAL_PENDING",
  "planId": "text",
  "planOverridden": true,
  "statusUpdateTime": "2026-06-07",
  "statusChangeNote": "text",
  "startTime": "2026-06-07",
  "quantity": 1,
  "customId": "text",
  "shippingAmount": {
    "value": 100,
    "currencyCode": "EUR"
  },
  "subscriber": {
    "name": {
      "givenName": "text",
      "surname": "text"
    },
    "payerId": "text",
    "emailAddress": "text",
    "phone": {
      "phoneType": "FAX",
      "phoneNumber": {
        "nationalNumber": "text"
      }
    },
    "shippingAddress": {
      "name": {
        "fullName": "text"
      },
      "address": {
        "country": "text",
        "postalCode": "text",
        "countrySubdivision": "text",
        "city": "text",
        "addressLine2": "text",
        "addressLine1": "text"
      }
    }
  },
  "billingInfo": {
    "outstandingBalance": {
      "value": 100,
      "currencyCode": "EUR"
    },
    "cycleExecutions": [
      {
        "tenureType": "REGULAR",
        "sequence": 1,
        "cyclesCompleted": 1,
        "cyclesRemaining": 1,
        "currentPricingSchemeVersion": 1,
        "totalCycles": 1
      }
    ],
    "lastPayment": {
      "status": "text",
      "amount": {
        "value": 100,
        "currencyCode": "EUR"
      },
      "time": "2026-06-07"
    },
    "nextBillingTime": "text",
    "finalPaymentTime": "text",
    "failedPaymentsCount": 1,
    "lastFailedPayment": {
      "amount": {
        "value": 100,
        "currencyCode": "EUR"
      },
      "time": "2026-06-07",
      "reasonCode": "CURRENCY_MISMATCH",
      "nextPaymentRetryTime": "2026-06-07"
    }
  },
  "createdAt": "2026-06-07",
  "updatedAt": "2026-06-07"
}

Update subscription

patch

https://emea.gsc.verifone.cloud/oidc/paypal-ecomhttps://us.gsc.verifone.cloud/oidc/paypal-ecomhttps://nz.gsc.verifone.cloud/oidc/paypal-ecomhttps://cst.test-gsc.vfims.com/oidc/paypal-ecomhttps://uscst.gb.gsc.cficloud/oidc/paypal-ecom

/subscriptions/{id}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

*/*

paymentProviderContractstringRequired

PayPal Payment Provider Contract UUID

Responses

204

No Content

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

patch

/subscriptions/{id}

HTTPcURLJavaScriptPython

PATCH /oidc/paypal-ecom/subscriptions/{id} HTTP/1.1
Host: emea.gsc.verifone.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: */*
Accept: */*
Content-Length: 1014

{
  "paymentProviderContract": "text",
  "startTime": {
    "op": "replace",
    "value": "2026-06-07"
  },
  "customId": {
    "op": "add",
    "value": "text"
  },
  "planPaymentPreferencesAutoBillOutstanding": {
    "op": "replace",
    "value": true
  },
  "planBillingCyclesPricingSchemeFixedPrice": {
    "op": "add",
    "value": {
      "value": 100,
      "currencyCode": "EUR"
    },
    "sequence": 1
  },
  "planBillingCyclesTotalCycles": {
    "op": "replace",
    "value": 1,
    "sequence": 1
  },
  "planBillingCyclesPricingSchemeTiers": {
    "op": "replace",
    "value": [
      {
        "startingQuantity": 1,
        "endingQuantity": 1,
        "amount": {
          "value": 100,
          "currencyCode": "EUR"
        }
      }
    ],
    "sequence": 1
  },
  "planTaxesPercentage": {
    "op": "add",
    "value": 1
  },
  "planTaxesInclusive": {
    "op": "add",
    "value": true
  },
  "subscriberShippingAddress": {
    "op": "add",
    "value": {
      "name": {
        "fullName": "text"
      },
      "address": {
        "country": "text",
        "postalCode": "text",
        "countrySubdivision": "text",
        "city": "text",
        "addressLine2": "text",
        "addressLine1": "text"
      }
    }
  },
  "billingInfoOutstandingBalance": {
    "op": "replace",
    "value": {
      "value": 100,
      "currencyCode": "EUR"
    }
  },
  "shippingAmount": {
    "op": "add",
    "value": {
      "value": 100,
      "currencyCode": "EUR"
    }
  }
}

No content

Revise subscription

post

https://emea.gsc.verifone.cloud/oidc/paypal-ecomhttps://us.gsc.verifone.cloud/oidc/paypal-ecomhttps://nz.gsc.verifone.cloud/oidc/paypal-ecomhttps://cst.test-gsc.vfims.com/oidc/paypal-ecomhttps://uscst.gb.gsc.cficloud/oidc/paypal-ecom

/subscriptions/{id}/revise

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

*/*

paymentProviderContractstringRequired

PayPal Payment Provider Contract UUID

planIdstring · min: 3 · max: 50Optional

The ID of the plan

effectiveTimestring · dateOptional

The date and time when this change is effective

quantityintegerOptional

The quantity of the product or service in the subscription

Responses

200

Successful

application/json

stringOptional

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post

/subscriptions/{id}/revise

HTTPcURLJavaScriptPython

POST /oidc/paypal-ecom/subscriptions/{id}/revise HTTP/1.1
Host: emea.gsc.verifone.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: */*
Accept: */*
Content-Length: 556

{
  "paymentProviderContract": "text",
  "planId": "text",
  "effectiveTime": "2026-06-07",
  "quantity": 1,
  "shippingAmount": {
    "value": 100,
    "currencyCode": "EUR"
  },
  "shippingAddress": {
    "name": {
      "fullName": "text"
    },
    "address": {
      "country": "text",
      "postalCode": "text",
      "countrySubdivision": "text",
      "city": "text",
      "addressLine2": "text",
      "addressLine1": "text"
    }
  },
  "applicationContext": {
    "brandName": "text",
    "locale": "text",
    "shippingPreference": "GET_FROM_FILE",
    "userAction": "CONTINUE",
    "paymentMethod": {
      "payerSelected": "text",
      "payeePreferred": "UNRESTRICTED"
    },
    "returnUrl": "text",
    "cancelUrl": "text"
  }
}

text

Cancel subscription

post

https://emea.gsc.verifone.cloud/oidc/paypal-ecomhttps://us.gsc.verifone.cloud/oidc/paypal-ecomhttps://nz.gsc.verifone.cloud/oidc/paypal-ecomhttps://cst.test-gsc.vfims.com/oidc/paypal-ecomhttps://uscst.gb.gsc.cficloud/oidc/paypal-ecom

/subscriptions/{id}/cancel

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

*/*

paymentProviderContractstringRequired

PayPal Payment Provider Contract UUID

reasonstringOptional

The reason for the cancellation of a subscription.

Responses

204

No Content

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post

/subscriptions/{id}/cancel

HTTPcURLJavaScriptPython

POST /oidc/paypal-ecom/subscriptions/{id}/cancel HTTP/1.1
Host: emea.gsc.verifone.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: */*
Accept: */*
Content-Length: 94

{
  "paymentProviderContract": "text",
  "reason": "text",
  "amount": {
    "value": 100,
    "currencyCode": "EUR"
  }
}

No content

Capture authorized payment on subscription

post

https://emea.gsc.verifone.cloud/oidc/paypal-ecomhttps://us.gsc.verifone.cloud/oidc/paypal-ecomhttps://nz.gsc.verifone.cloud/oidc/paypal-ecomhttps://cst.test-gsc.vfims.com/oidc/paypal-ecomhttps://uscst.gb.gsc.cficloud/oidc/paypal-ecom

/subscriptions/{id}/capture

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Header parameters

x-vfi-api-idempotencyKeystringOptional

A value you specify that uniquely identifies the transaction. If you're unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about duplicating the transaction.

Body

*/*

paymentProviderContractstringRequired

PayPal Payment Provider Contract UUID

reasonstringRequired

The reason or note for the subscription charge.

Responses

202

Accepted

post

/subscriptions/{id}/capture

HTTPcURLJavaScriptPython

POST /oidc/paypal-ecom/subscriptions/{id}/capture HTTP/1.1
Host: emea.gsc.verifone.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: */*
Accept: */*
Content-Length: 94

{
  "paymentProviderContract": "text",
  "reason": "text",
  "amount": {
    "currencyCode": "EUR",
    "value": 100
  }
}

202

Accepted

No content

Activate subscription

post

https://emea.gsc.verifone.cloud/oidc/paypal-ecomhttps://us.gsc.verifone.cloud/oidc/paypal-ecomhttps://nz.gsc.verifone.cloud/oidc/paypal-ecomhttps://cst.test-gsc.vfims.com/oidc/paypal-ecomhttps://uscst.gb.gsc.cficloud/oidc/paypal-ecom

/subscriptions/{id}/activate

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

*/*

reasonstringOptional

The reason for activation of a subscription

paymentProviderContractstringRequired

PayPal Payment Provider Contract UUID

Responses

204

No Content

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post

/subscriptions/{id}/activate

HTTPcURLJavaScriptPython

POST /oidc/paypal-ecom/subscriptions/{id}/activate HTTP/1.1
Host: emea.gsc.verifone.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: */*
Accept: */*
Content-Length: 50

{
  "reason": "text",
  "paymentProviderContract": "text"
}

No content

Suspend subscription

post

https://emea.gsc.verifone.cloud/oidc/paypal-ecomhttps://us.gsc.verifone.cloud/oidc/paypal-ecomhttps://nz.gsc.verifone.cloud/oidc/paypal-ecomhttps://cst.test-gsc.vfims.com/oidc/paypal-ecomhttps://uscst.gb.gsc.cficloud/oidc/paypal-ecom

/subscriptions/{id}/suspend

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

*/*

paymentProviderContractstringRequired

PayPal Payment Provider Contract UUID

reasonstringOptional

The reason for suspenson of the subscription.

Responses

204

No Content

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post

/subscriptions/{id}/suspend

HTTPcURLJavaScriptPython

POST /oidc/paypal-ecom/subscriptions/{id}/suspend HTTP/1.1
Host: emea.gsc.verifone.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: */*
Accept: */*
Content-Length: 50

{
  "paymentProviderContract": "text",
  "reason": "text"
}

No content