Create Subscription

curl --request POST \
  --url https://api.revolv3.com/api/Subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "paymentMethods": [
    {
      "priority": 0,
      "taxAmount": 2.56,
      "originalNetworkTransactionId": "102656693ac3ca6e0cdafbfe89ab99",
      "billingAddress": {
        "addressId": null,
        "addressLine1": "100 Main Street",
        "addressLine2": null,
        "city": "Irvine",
        "state": "CA",
        "postalCode": "92602",
        "phoneNumber": null,
        "email": null,
        "country": "US"
      },
      "creditCard": {
        "paymentAccountNumber": "4111111111111111",
        "expirationDate": "1025",
        "securityCode": null,
        "networkToken": null
      },
      "ach": null,
      "googlePay": null,
      "applePay": null,
      "merchantPaymentMethodRefId": "payment-method-ref-id_hgays-213-44d",
      "billingFirstName": "John",
      "billingLastName": "Doe",
      "billingFullName": null
    },
    {
      "priority": 1,
      "taxAmount": 1.34,
      "originalNetworkTransactionId": null,
      "billingAddress": {
        "addressId": null,
        "addressLine1": "100 Main Street 2",
        "addressLine2": null,
        "city": "Irvine ",
        "state": "CA",
        "postalCode": "9260e",
        "phoneNumber": null,
        "email": null,
        "country": "US"
      },
      "creditCard": {
        "paymentAccountNumber": "5555555555554444",
        "expirationDate": "03/2030",
        "securityCode": null,
        "networkToken": null
      },
      "ach": null,
      "googlePay": null,
      "applePay": null,
      "merchantPaymentMethodRefId": "payment-method-ref-id_hgays-213-4rf4344",
      "billingFirstName": "John",
      "billingLastName": "Doe",
      "billingFullName": null
    }
  ],
  "existingPaymentMethod": null,
  "merchantSubscriptionRefId": "1234-5678-9101",
  "billingFrequency": {
    "intervalType": "Days",
    "intervalCount": 1
  },
  "subscriptionStatusType": "current",
  "subscriptionCancelType": "immediate",
  "startDate": "2026-03-30T00:00:00Z",
  "trialDuration": 0,
  "trialDurationType": "Days",
  "taxAddress": {
    "addressId": null,
    "addressLine1": "101 Update Street",
    "addressLine2": null,
    "city": "Irvine",
    "state": "CA",
    "postalCode": "92602",
    "phoneNumber": null,
    "email": null,
    "country": "US"
  },
  "includeRawProcessorResponse": false,
  "customer": {
    "id": 1,
    "firstName": null,
    "lastName": null
  },
  "subscriptionBillingPlans": [
    {
      "name": "Billing Plan 1",
      "value": 10.99,
      "cycleCount": -1,
      "valueType": "Standard",
      "startCycleDelay": 0
    },
    {
      "name": "Billing Plan 2",
      "value": 14.99,
      "cycleCount": 12,
      "valueType": "Standard",
      "startCycleDelay": 1
    }
  ],
  "recycleImmediatePayment": false,
  "currency": "USD"
}
'

{
  "subscriptionId": 1,
  "customerId": 1,
  "merchantSubscriptionRefId": "1234-5678-9101",
  "networkTransactionId": null,
  "billingIntervalType": "Months",
  "billingIntervalCount": 1,
  "subscriptionStatusType": "Current",
  "subscriptionCancelType": "Immediate",
  "initialBillDate": "30-Mar-26",
  "nextBillDate": "30-Apr-26",
  "taxAddress": null,
  "paymentMethodIds": [
    1,
    2
  ],
  "cancelledAt": null,
  "billingPlans": [
    {
      "subscriptionBillingPlanId": 1,
      "subscriptionId": 0,
      "name": "Billing Plan 1",
      "value": 10.99,
      "startDate": "30-Mar-26",
      "cyclesRemaining": -1,
      "cycleCount": 0,
      "valueType": "Standard"
    },
    {
      "subscriptionBillingPlanId": 2,
      "subscriptionId": 0,
      "name": "Billing Plan 2",
      "value": 14.99,
      "startDate": "30-Apr-26",
      "cyclesRemaining": 12,
      "cycleCount": 0,
      "valueType": "Standard"
    }
  ],
  "message": null,
  "paymentProcessor": null,
  "processorMerchantId": null,
  "processorRawResponse": null,
  "currency": null,
  "responseMessage": null,
  "responseCode": null
}

Subscriptions

Create Subscription

Creates a new subscription for a customer, linking a recurring billing plan to their payment method. You must provide details such as the customer, start date, and payment method.

Once created, the system will automatically generate invoices and process payments based on the defined billing interval. Optional settings may include trial periods or metadata for internal tracking.

This endpoint is typically used during customer onboarding, upgrades, or checkout flows that involve recurring services.

Create Subscription

curl --request POST \
  --url https://api.revolv3.com/api/Subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "paymentMethods": [
    {
      "priority": 0,
      "taxAmount": 2.56,
      "originalNetworkTransactionId": "102656693ac3ca6e0cdafbfe89ab99",
      "billingAddress": {
        "addressId": null,
        "addressLine1": "100 Main Street",
        "addressLine2": null,
        "city": "Irvine",
        "state": "CA",
        "postalCode": "92602",
        "phoneNumber": null,
        "email": null,
        "country": "US"
      },
      "creditCard": {
        "paymentAccountNumber": "4111111111111111",
        "expirationDate": "1025",
        "securityCode": null,
        "networkToken": null
      },
      "ach": null,
      "googlePay": null,
      "applePay": null,
      "merchantPaymentMethodRefId": "payment-method-ref-id_hgays-213-44d",
      "billingFirstName": "John",
      "billingLastName": "Doe",
      "billingFullName": null
    },
    {
      "priority": 1,
      "taxAmount": 1.34,
      "originalNetworkTransactionId": null,
      "billingAddress": {
        "addressId": null,
        "addressLine1": "100 Main Street 2",
        "addressLine2": null,
        "city": "Irvine ",
        "state": "CA",
        "postalCode": "9260e",
        "phoneNumber": null,
        "email": null,
        "country": "US"
      },
      "creditCard": {
        "paymentAccountNumber": "5555555555554444",
        "expirationDate": "03/2030",
        "securityCode": null,
        "networkToken": null
      },
      "ach": null,
      "googlePay": null,
      "applePay": null,
      "merchantPaymentMethodRefId": "payment-method-ref-id_hgays-213-4rf4344",
      "billingFirstName": "John",
      "billingLastName": "Doe",
      "billingFullName": null
    }
  ],
  "existingPaymentMethod": null,
  "merchantSubscriptionRefId": "1234-5678-9101",
  "billingFrequency": {
    "intervalType": "Days",
    "intervalCount": 1
  },
  "subscriptionStatusType": "current",
  "subscriptionCancelType": "immediate",
  "startDate": "2026-03-30T00:00:00Z",
  "trialDuration": 0,
  "trialDurationType": "Days",
  "taxAddress": {
    "addressId": null,
    "addressLine1": "101 Update Street",
    "addressLine2": null,
    "city": "Irvine",
    "state": "CA",
    "postalCode": "92602",
    "phoneNumber": null,
    "email": null,
    "country": "US"
  },
  "includeRawProcessorResponse": false,
  "customer": {
    "id": 1,
    "firstName": null,
    "lastName": null
  },
  "subscriptionBillingPlans": [
    {
      "name": "Billing Plan 1",
      "value": 10.99,
      "cycleCount": -1,
      "valueType": "Standard",
      "startCycleDelay": 0
    },
    {
      "name": "Billing Plan 2",
      "value": 14.99,
      "cycleCount": 12,
      "valueType": "Standard",
      "startCycleDelay": 1
    }
  ],
  "recycleImmediatePayment": false,
  "currency": "USD"
}
'

{
  "subscriptionId": 1,
  "customerId": 1,
  "merchantSubscriptionRefId": "1234-5678-9101",
  "networkTransactionId": null,
  "billingIntervalType": "Months",
  "billingIntervalCount": 1,
  "subscriptionStatusType": "Current",
  "subscriptionCancelType": "Immediate",
  "initialBillDate": "30-Mar-26",
  "nextBillDate": "30-Apr-26",
  "taxAddress": null,
  "paymentMethodIds": [
    1,
    2
  ],
  "cancelledAt": null,
  "billingPlans": [
    {
      "subscriptionBillingPlanId": 1,
      "subscriptionId": 0,
      "name": "Billing Plan 1",
      "value": 10.99,
      "startDate": "30-Mar-26",
      "cyclesRemaining": -1,
      "cycleCount": 0,
      "valueType": "Standard"
    },
    {
      "subscriptionBillingPlanId": 2,
      "subscriptionId": 0,
      "name": "Billing Plan 2",
      "value": 14.99,
      "startDate": "30-Apr-26",
      "cyclesRemaining": 12,
      "cycleCount": 0,
      "valueType": "Standard"
    }
  ],
  "message": null,
  "paymentProcessor": null,
  "processorMerchantId": null,
  "processorRawResponse": null,
  "currency": null,
  "responseMessage": null,
  "responseCode": null
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

billingFrequency

object

required

Show child attributes

customer

object

required

Show child attributes

subscriptionBillingPlans

object[]

required

Show child attributes

paymentMethods

object[] | null

Show child attributes

existingPaymentMethod

object

Show child attributes

merchantSubscriptionRefId

string | null

subscriptionStatusType

string | null

default:Current

subscriptionCancelType

string | null

default:EndOfCycle

startDate

string<date-time> | null

default:Today's date

trialDuration

integer<int32> | null

default:0

trialDurationType

enum<string>

Available options:

Days,

Weeks,

Months,

Years

taxAddress

object

Show child attributes

includeRawProcessorResponse

boolean | null

default:false

recycleImmediatePayment

boolean | null

default:false

currency

enum<string>

Available options:

USD,

AED,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BMD,

BND,

BOB,

BRL,

BSD,

BWP,

BYN,

BZD,

CAD,

CHF,

CLP,

CNH,

CNY,

COP,

CRC,

CUP,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

ISK,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LYD,

MAD,

MDL,

MKD,

MMK,

MNT,

MOP,

MRU,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SEK,

SGD,

SHP,

SLE,

SOS,

SRD,

STN,

SVC,

SZL,

THB,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

UYU,

UZS,

VEF,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW,

AFN,

KPW,

LRD,

LSL,

STD,

SYP,

TJS,

ZMK,

ZWD,

SLL,

MGA,

HRK,

CDF,

BTN,

BIF

Response

Created

subscriptionId

integer<int64>

customerId

integer<int64>

merchantSubscriptionRefId

string | null

networkTransactionId

string | null

billingIntervalType

string | null

billingIntervalCount

integer<int32>

subscriptionStatusType

string | null

subscriptionCancelType

string | null

initialBillDate

string | null

nextBillDate

string | null

taxAddress

object

Show child attributes

paymentMethodIds

integer<int64>[] | null

cancelledAt

string<date-time> | null

billingPlans

object[] | null

Show child attributes

message

string | null

paymentProcessor

string | null

processorMerchantId

string | null

processorRawResponse

string | null

currency

string | null

responseMessage

string | null

responseCode

string | null

Get Subscriptions Get Subscription

⌘I