listSites (options)

List sites

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_sites

Returns

Examples

const sites = client.listSites({ params: { limit: 200 } })

for await (const site of sites.each()) {
  console.log(site.subdomain)
}

getSite (siteId, options)

Fetch a site

API docs: https://developers.recurly.com/api/v2021-02-25#operation/get_site

Returns

Examples

try {
  const site = await client.getSite(siteId)
  console.log('Fetched site: ', site)
} catch (err) {
  if (err instanceof recurly.errors.NotFoundError) {
    // If the request was not found, you may want to alert the user or
    // just return null
    console.log('Resource Not Found')
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

listAccounts (options)

List a site's accounts

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_accounts

Returns

Examples

const accounts = client.listAccounts({ params: { limit: 200 } })

for await (const account of accounts.each()) {
  console.log(account.code)
}

createAccount (body, options)

Create an account

API docs: https://developers.recurly.com/api/v2021-02-25#operation/create_account

Returns

Examples

try {
  const accountCreate = {
    code: accountCode,
    firstName: 'Benjamin',
    lastName: 'Du Monde',
    preferredTimeZone: 'America/Chicago',
    address: {
      street1: '900 Camp St',
      city: 'New Orleans',
      region: 'LA',
      postalCode: '70115',
      country: 'US'
    }
  }
  const account = await client.createAccount(accountCreate)
  console.log('Created Account: ', account.code)
} catch (err) {
  if (err instanceof recurly.errors.ValidationError) {
    // If the request was not valid, you may want to tell your user
    // why. You can find the invalid params and reasons in err.params
    console.log('Failed validation', err.params)
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

getAccount (accountId, options)

Fetch an account

API docs: https://developers.recurly.com/api/v2021-02-25#operation/get_account

Returns

Examples

try {
  const account = await client.getAccount(accountId)
  console.log('Fetched account: ', account.code)
} catch (err) {
  if (err instanceof recurly.errors.NotFoundError) {
    // If the request was not found, you may want to alert the user or
    // just return null
    console.log('Resource Not Found')
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

updateAccount (accountId, body, options)

Update an account

API docs: https://developers.recurly.com/api/v2021-02-25#operation/update_account

Returns

Examples

try {
  const accountUpdate = {
    firstName: 'Aaron',
    lastName: 'Du Monde'
  }
  const account = await client.updateAccount(accountId, accountUpdate)
  console.log('Updated account: ', account)
} catch (err) {
  if (err instanceof recurly.errors.ValidationError) {
    // If the request was not valid, you may want to tell your user
    // why. You can find the invalid params and reasons in err.params
    console.log('Failed validation', err.params)
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

deactivateAccount (accountId, options)

Deactivate an account

API docs: https://developers.recurly.com/api/v2021-02-25#operation/deactivate_account

Returns

Examples

try {
  const account = await client.deactivateAccount(accountId)
  console.log('Deleted account: ', account.code)
} catch (err) {
  if (err && err.type === 'not-found') {
    // If the request was not found, you may want to alert the user or
    // just return null
    console.log('Resource Not Found')
  }
  // If we don't know what to do with the err, we should
  // probably re-raise and let our web framework and logger handle it
  throw err
}

getAccountAcquisition (accountId, options)

Fetch an account's acquisition data

API docs: https://developers.recurly.com/api/v2021-02-25#operation/get_account_acquisition

Returns

Examples

try {
  const acquisition = await client.getAccountAcquisition(accountId)
  console.log('Fetched account acquisition: ', acquisition.id)
} catch (err) {
  if (err instanceof recurly.errors.NotFoundError) {
    // If the request was not found, you may want to alert the user or
    // just return null
    console.log('Resource Not Found')
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

updateAccountAcquisition (accountId, body, options)

Update an account's acquisition data

API docs: https://developers.recurly.com/api/v2021-02-25#operation/update_account_acquisition

Returns

Examples

try {
  const acquisitionUpdate = {
    campaign: "big-event-campaign",
    channel: "social_media",
    subchannel: "twitter"
  }
  const accountAcquisition = await client.updateAccountAcquisition(accountId, acquisitionUpdate)
  console.log('Edited Account Acquisition: ', accountAcquisition)
} catch (err) {
  if (err instanceof recurly.errors.ValidationError) {
    // If the request was not valid, you may want to tell your user
    // why. You can find the invalid params and reasons in err.params
    console.log('Failed validation', err.params)
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

removeAccountAcquisition (accountId, options)

Remove an account's acquisition data

API docs: https://developers.recurly.com/api/v2021-02-25#operation/remove_account_acquisition

Returns

Examples

try {
  await client.removeAccountAcquisition(accountId)
  console.log('Removed account acquisition from account: ', accountId)
} catch (err) {
  if (err instanceof recurly.errors.NotFoundError) {
    // If the request was not found, you may want to alert the user or
    // just return null
    console.log('Resource Not Found')
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

reactivateAccount (accountId, options)

Reactivate an inactive account

API docs: https://developers.recurly.com/api/v2021-02-25#operation/reactivate_account

Returns

Examples

try {
  const account = await client.reactivateAccount(accountId)
  console.log('Reactivated account: ', account.code)
} catch (err) {
  if (err && err.type === 'not_found') {
    // If the request was not found, you may want to alert the user or
    // just return null
    console.log('Resource Not Found')
  }
  // If we don't know what to do with the err, we should
  // probably re-raise and let our web framework and logger handle it
  throw err
}

getAccountBalance (accountId, options)

Fetch an account's balance and past due status

API docs: https://developers.recurly.com/api/v2021-02-25#operation/get_account_balance

Returns

Examples

try {
  const balance = await client.getAccountBalance(accountId)
  console.log('Fetched account balance: ', balance.balances)
} catch (err) {
  if (err instanceof recurly.errors.NotFoundError) {
    // If the request was not found, you may want to alert the user or
    // just return null
    console.log('Resource Not Found')
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

getBillingInfo (accountId, options)

Fetch an account's billing information

API docs: https://developers.recurly.com/api/v2021-02-25#operation/get_billing_info

Returns

Examples

try {
  const billingInfo = await client.getBillingInfo(accountId)
  console.log('Fetched Billing Info: ', billingInfo.id)
} catch (err) {
  if (err instanceof recurly.errors.NotFoundError) {
    // If the request was not found, you may want to alert the user or
    // just return null
    console.log('Resource Not Found')
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

updateBillingInfo (accountId, body, options)

Set an account's billing information

API docs: https://developers.recurly.com/api/v2021-02-25#operation/update_billing_info

Returns

Examples

try {
  const billingInfoUpdate = {
    firstName: 'Aaron',
    lastName: 'Du Monde',
  }
  const billingInfo = await client.updateBillingInfo(accountId, billingInfoUpdate)
  console.log('Updated billing info: ', billingInfo.id)
} catch (err) {
  if (err instanceof recurly.errors.ValidationError) {
    // If the request was not valid, you may want to tell your user
    // why. You can find the invalid params and reasons in err.params
    console.log('Failed validation', err.params)
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

removeBillingInfo (accountId, options)

Remove an account's billing information

API docs: https://developers.recurly.com/api/v2021-02-25#operation/remove_billing_info

Returns

Examples

try {
  client.removeBillingInfo(accountId)
  console.log('Removed billing info from account: ', accountId)
} catch (err) {
  if (err instanceof recurly.errors.NotFoundError) {
    // If the request was not found, you may want to alert the user or
    // just return null
    console.log('Resource Not Found')
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

verifyBillingInfo (accountId, options)

Verify an account's credit card billing information

API docs: https://developers.recurly.com/api/v2021-02-25#operation/verify_billing_info

Returns

Examples

try {
  const transaction = await client.verifyBillingInfo(accountId)
  console.log('Fetched Transaction: ', transaction.id)
} catch (err) {
  if (err instanceof recurly.errors.NotFoundError) {
    // If the request was not found, you may want to alert the user or
    // just return null
    console.log('Resource Not Found')
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

verifyBillingInfoCvv (accountId, body, options)

Verify an account's credit card billing cvv

API docs: https://developers.recurly.com/api/v2021-02-25#operation/verify_billing_info_cvv

Returns

listBillingInfos (accountId, options)

Get the list of billing information associated with an account

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_billing_infos

Returns

createBillingInfo (accountId, body, options)

Add new billing information on an account

API docs: https://developers.recurly.com/api/v2021-02-25#operation/create_billing_info

Returns

getABillingInfo (accountId, billingInfoId, options)

Fetch a billing info

API docs: https://developers.recurly.com/api/v2021-02-25#operation/get_a_billing_info

Returns

updateABillingInfo (accountId, billingInfoId, body, options)

Update an account's billing information

API docs: https://developers.recurly.com/api/v2021-02-25#operation/update_a_billing_info

Returns

removeABillingInfo (accountId, billingInfoId, options)

Remove an account's billing information

API docs: https://developers.recurly.com/api/v2021-02-25#operation/remove_a_billing_info

Returns

listAccountCouponRedemptions (accountId, options)

List the coupon redemptions for an account

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_account_coupon_redemptions

Returns

Examples

const redemptions = client.listAccountCouponRedemptions(accountId, { params: { limit: 200 } })

for await (const redemption of redemptions.each()) {
  console.log(redemption.id)
}

listActiveCouponRedemptions (accountId, options)

List the coupon redemptions that are active on an account

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_active_coupon_redemptions

Returns

Examples

const redemptions = await client.listActiveCouponRedemptions(accountId, { params: { limit: 200 } })

for await (const redemption of redemptions.each()) {
  console.log('Fetched coupon redemption: ', redemption.id)
}

createCouponRedemption (accountId, body, options)

Generate an active coupon redemption on an account or subscription

API docs: https://developers.recurly.com/api/v2021-02-25#operation/create_coupon_redemption

Returns

removeCouponRedemption (accountId, options)

Delete the active coupon redemption from an account

API docs: https://developers.recurly.com/api/v2021-02-25#operation/remove_coupon_redemption

Returns

Examples

try {
  const redemption = await client.removeCouponRedemption(accountId)
  console.log('Removed coupon redemption: ', redemption.id)
} catch (err) {
  if (err instanceof recurly.errors.NotFoundError) {
    // If the request was not found, you may want to alert the user or
    // just return null
    console.log('Resource Not Found')
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

listAccountCreditPayments (accountId, options)

List an account's credit payments

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_account_credit_payments

Returns

Examples

const payments = client.listAccountCreditPayments(accountId, { params: { limit: 200 } })

for await (const payment of payments.each()) {
  console.log(payment.uuid)
}

listAccountExternalAccount (accountId, options)

List external accounts for an account

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_account_external_account

Returns

createAccountExternalAccount (accountId, body, options)

Create an external account

API docs: https://developers.recurly.com/api/v2021-02-25#operation/create_account_external_account

Returns

getAccountExternalAccount (accountId, externalAccountId, options)

Get an external account for an account

API docs: https://developers.recurly.com/api/v2021-02-25#operation/get_account_external_account

Returns

updateAccountExternalAccount (accountId, externalAccountId, body, options)

Update an external account

API docs: https://developers.recurly.com/api/v2021-02-25#operation/update_account_external_account

Returns

deleteAccountExternalAccount (accountId, externalAccountId, options)

Delete an external account for an account

API docs: https://developers.recurly.com/api/v2021-02-25#operation/delete_account_external_account

Returns

listAccountExternalInvoices (accountId, options)

List the external invoices on an account

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_account_external_invoices

Returns

listAccountInvoices (accountId, options)

List an account's invoices

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_account_invoices

Returns

Examples

const invoices = client.listAccountInvoices(accountId, { params: { limit: 200 } })

for await (const invoice of invoices.each()) {
  console.log(invoice.number)
}

createInvoice (accountId, body, options)

Create an invoice for pending line items

API docs: https://developers.recurly.com/api/v2021-02-25#operation/create_invoice

Returns

Examples

try {
  let invoiceCreate = {
    currency: 'USD',
    collectionMethod: 'automatic'
  }
  let invoiceCollection = await client.createInvoice(accountId, invoiceCreate)
  console.log('Created Invoice')
  console.log('Charge Invoice: ', invoiceCollection.chargeInvoice)
  console.log('Credit Invoices: ', invoiceCollection.creditInvoices)
} catch (err) {
  if (err instanceof recurly.errors.ValidationError) {
    // If the request was not valid, you may want to tell your user
    // why. You can find the invalid params and reasons in err.params
    console.log('Failed validation', err.params)
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

previewInvoice (accountId, body, options)

Preview new invoice for pending line items

API docs: https://developers.recurly.com/api/v2021-02-25#operation/preview_invoice

Returns

Examples

try {
  const collection = await client.previewInvoice(accountId, {
    currency: "USD",
    collectionMethod: "automatic"
  })
  console.log(`Previewed invoice due at ${collection.chargeInvoice.dueAt}`)
  console.log(collection.chargeInvoice)
  console.log(collection.creditInvoices)
} catch(err) {

  if (err instanceof recurly.errors.ValidationError) {
    // If the request was not valid, you may want to tell your user
    // why. You can find the invalid params and reasons in err.params
    console.log('Failed validation', err.params)
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

listAccountLineItems (accountId, options)

List an account's line items

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_account_line_items

Returns

Examples

const lineItems = client.listAccountLineItems(accountId, { params: { limit: 200 } })

for await (const lineItem of lineItems.each()) {
  console.log(lineItem.id)
}

createLineItem (accountId, body, options)

Create a new line item for the account

API docs: https://developers.recurly.com/api/v2021-02-25#operation/create_line_item

Returns

Examples

try {
  let lineItemReq = {
    currency: 'USD',
    unitAmount: 1000,
    type: 'charge' // choose "credit" for a credit
  }
  let lineItem = await client.createLineItem(accountId, lineItemReq)
  console.log('Created Line Item: ', lineItem.uuid)
} catch (err) {
  if (err instanceof recurly.errors.ValidationError) {
    // If the request was not valid, you may want to tell your user
    // why. You can find the invalid params and reasons in err.params
    console.log('Failed validation', err.params)
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

listAccountNotes (accountId, options)

List an account's notes

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_account_notes

Returns

Examples

const notes = client.listAccountNotes(accountId, { params: { limit: 200 } })

for await (const note of notes.each()) {
  console.log(note.message)
}

getAccountNote (accountId, accountNoteId, options)

Fetch an account note

API docs: https://developers.recurly.com/api/v2021-02-25#operation/get_account_note

Returns

Examples

try {
  console.log(accountId)
  const note = await client.getAccountNote(accountId, accountNoteId)
  console.log('Fetched account note: ', note.message)
} catch (err) {
  if (err instanceof recurly.errors.NotFoundError) {
    // If the request was not found, you may want to alert the user or
    // just return null
    console.log('Resource Not Found')
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

listShippingAddresses (accountId, options)

Fetch a list of an account's shipping addresses

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_shipping_addresses

Returns

Examples

const addresses = client.listShippingAddresses(accountId, { params: { limit: 200 } })

for await (const address of addresses.each()) {
  console.log(address.street1)
}

createShippingAddress (accountId, body, options)

Create a new shipping address for the account

API docs: https://developers.recurly.com/api/v2021-02-25#operation/create_shipping_address

Returns

Examples

try {
  const shippingAddressCreate = {
    firstName: 'Aaron',
    lastName: 'Du Monde',
    street1: '900 Camp St.',
    city: 'New Orleans',
    region: 'LA',
    postalCode: '70115',
    country: 'US'
  }
  const address = await client.createShippingAddress(accountId, shippingAddressCreate)
  console.log('Created shipping address: ', address.street1)
} catch (err) {
  if (err instanceof recurly.errors.ValidationError) {
    // If the request was not valid, you may want to tell your user
    // why. You can find the invalid params and reasons in err.params
    console.log('Failed validation', err.params)
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

getShippingAddress (accountId, shippingAddressId, options)

Fetch an account's shipping address

API docs: https://developers.recurly.com/api/v2021-02-25#operation/get_shipping_address

Returns

Examples

try {
  const address = await client.getShippingAddress(accountId, shippingAddressId)
  console.log('Fetched shipping address: ', address.street1)
} catch (err) {
  if (err instanceof recurly.errors.NotFoundError) {
    // If the request was not found, you may want to alert the user or
    // just return null
    console.log('Resource Not Found')
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

updateShippingAddress (accountId, shippingAddressId, body, options)

Update an account's shipping address

API docs: https://developers.recurly.com/api/v2021-02-25#operation/update_shipping_address

Returns

Examples

try {
  const shadUpdate = {
    firstName: "Benjamin",
    lastName: "Du Monde"
  }
  const address = await client.updateShippingAddress(accountId, shippingAddressId, shadUpdate)
  console.log('Updated shipping address: ', address.street1)
} catch (err) {
  if (err instanceof recurly.errors.ValidationError) {
    // If the request was not valid, you may want to tell your user
    // why. You can find the invalid params and reasons in err.params
    console.log('Failed validation', err.params)
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

removeShippingAddress (accountId, shippingAddressId, options)

Remove an account's shipping address

API docs: https://developers.recurly.com/api/v2021-02-25#operation/remove_shipping_address

Returns

Examples

try {
  await client.removeShippingAddress(accountId, shippingAddress.id)
  console.log('Removed shipping address: ', shippingAddress.street1)
} catch (err) {
  if (err instanceof recurly.errors.NotFoundError) {
    // If the request was not found, you may want to alert the user or
    // just return null
    console.log('Resource Not Found')
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

listAccountSubscriptions (accountId, options)

List an account's subscriptions

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_account_subscriptions

Returns

Examples

const subscriptions = client.listAccountSubscriptions(accountId, { params: { limit: 200 } })

for await (const subscription of subscriptions.each()) {
  console.log(subscription.uuid)
}

listAccountTransactions (accountId, options)

List an account's transactions

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_account_transactions

Returns

Examples

const transactions = client.listAccountTransactions(accountId, { params: { limit: 200 } })

for await (const transaction of transactions.each()) {
  console.log(transaction.uuid)
}

listChildAccounts (accountId, options)

List an account's child accounts

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_child_accounts

Returns

listAccountAcquisition (options)

List a site's account acquisition data

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_account_acquisition

Returns

Examples

const acquisitions = client.listAccountAcquisition({ params: { limit: 200 } })

for await (const acquisition of acquisitions.each()) {
  console.log(acquisition.id)
}

listCoupons (options)

List a site's coupons

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_coupons

Returns

Examples

const coupons = client.listCoupons({ params: { limit: 200 } })

for await (const coupon of coupons.each()) {
  console.log(coupon.code)
}

createCoupon (body, options)

Create a new coupon

API docs: https://developers.recurly.com/api/v2021-02-25#operation/create_coupon

Returns

Examples

try {
  const couponCreate = {
    name: "Promotional Coupon",
    code: couponCode,
    discount_type: "fixed",
    currencies: [{"currency": "USD", "discount": 10}],
  }
  const coupon = await client.createCoupon(couponCreate)
  console.log('Created coupon: ', coupon.id)
} catch (err) {
  if (err instanceof recurly.errors.ValidationError) {
    // If the request was not valid, you may want to tell your user
    // why. You can find the invalid params and reasons in err.params
    console.log('Failed validation', err.params)
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

getCoupon (couponId, options)

Fetch a coupon

API docs: https://developers.recurly.com/api/v2021-02-25#operation/get_coupon

Returns

Examples

try {
  const coupon = await client.getCoupon(couponId)
  console.log('Fetched coupon: ', coupon.code)
} catch (err) {
  if (err instanceof recurly.errors.NotFoundError) {
    // If the request was not found, you may want to alert the user or
    // just return null
    console.log('Resource Not Found')
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

updateCoupon (couponId, body, options)

Update an active coupon

API docs: https://developers.recurly.com/api/v2021-02-25#operation/update_coupon

Returns

Examples

try {
  const couponUpdate = {
    name: "New Coupon Name"
  }
  const coupon = await client.updateCoupon(couponId, couponUpdate)
  console.log('Updated coupon: ', coupon)
} catch (err) {
  if (err instanceof recurly.errors.ValidationError) {
    // If the request was not valid, you may want to tell your user
    // why. You can find the invalid params and reasons in err.params
    console.log('Failed validation', err.params)
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

deactivateCoupon (couponId, options)

Expire a coupon

API docs: https://developers.recurly.com/api/v2021-02-25#operation/deactivate_coupon

Returns

Examples

try {
  const coupon = await client.deactivateCoupon(couponId)
  console.log('Deactivated coupon: ', coupon.code)
} catch (err) {
  if (err instanceof recurly.errors.NotFoundError) {
    // If the request was not found, you may want to alert the user or
    // just return null
    console.log('Resource Not Found')
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

generateUniqueCouponCodes (couponId, body, options)

Generate unique coupon codes

API docs: https://developers.recurly.com/api/v2021-02-25#operation/generate_unique_coupon_codes

Returns

restoreCoupon (couponId, body, options)

Restore an inactive coupon

API docs: https://developers.recurly.com/api/v2021-02-25#operation/restore_coupon

Returns

listUniqueCouponCodes (couponId, options)

List unique coupon codes associated with a bulk coupon

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_unique_coupon_codes

Returns

listCreditPayments (options)

List a site's credit payments

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_credit_payments

Returns

Examples

const payments = client.listCreditPayments({ params: { limit: 200 } })

for await (const payment of payments.each()) {
  console.log(payment.uuid)
}

getCreditPayment (creditPaymentId, options)

Fetch a credit payment

API docs: https://developers.recurly.com/api/v2021-02-25#operation/get_credit_payment

Returns

listCustomFieldDefinitions (options)

List a site's custom field definitions

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_custom_field_definitions

Returns

Examples

const definitions = client.listCustomFieldDefinitions({ params: { limit: 200 } })

for await (const definition of definitions.each()) {
  console.log(definition.displayName)
}

getCustomFieldDefinition (customFieldDefinitionId, options)

Fetch an custom field definition

API docs: https://developers.recurly.com/api/v2021-02-25#operation/get_custom_field_definition

Returns

Examples

try {
  const definition = await client.getCustomFieldDefinition(definitionId)
  console.log('Fetched custom field definition: ', definition.displayName)
} catch (err) {
  if (err instanceof recurly.errors.NotFoundError) {
    // If the request was not found, you may want to alert the user or
    // just return null
    console.log('Resource Not Found')
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

listInvoiceTemplateAccounts (invoiceTemplateId, options)

List an invoice template's associated accounts

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_invoice_template_accounts

Returns

listItems (options)

List a site's items

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_items

Returns

Examples

const items = client.listItems({ params: { limit: 200 } })

for await (const item of items.each()) {
  console.log(item.code)
}

createItem (body, options)

Create a new item

API docs: https://developers.recurly.com/api/v2021-02-25#operation/create_item

Returns

Examples

try {
  const itemCreate = {
    code: itemCode,
    name: "Item Name",
    description: "Item Description",
    external_sku: "a35JE-44",
    accounting_code: "item-code-127",
    revenue_schedule_type: "at_range_end",
    custom_fields: [{
      name: "custom-field-1",
      value: "Custom Field 1 value"
    }]
  }
  const item = await client.createItem(itemCreate)
  console.log('Created Item: ', item.code)
} catch (err) {
  if (err instanceof recurly.errors.ValidationError) {
    // If the request was not valid, you may want to tell your user
    // why. You can find the invalid params and reasons in err.params
    console.log('Failed validation', err.params)
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

getItem (itemId, options)

Fetch an item

API docs: https://developers.recurly.com/api/v2021-02-25#operation/get_item

Returns

Examples

try {
  const item = await client.getItem(itemId)
  console.log('Fetched item: ', item.code)
} catch (err) {
  if (err instanceof recurly.errors.NotFoundError) {
    // If the request was not found, you may want to alert the user or
    // just return null
    console.log('Resource Not Found')
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

updateItem (itemId, body, options)

Update an active item

API docs: https://developers.recurly.com/api/v2021-02-25#operation/update_item

Returns

Examples

try {
  const itemUpdate = {
    name: 'New Item Name',
    description: 'New Item Description'
  }
  const item = await client.updateItem(itemId, itemUpdate)
  console.log('Updated item: ', item)
} catch (err) {
  if (err instanceof recurly.errors.ValidationError) {
    // If the request was not valid, you may want to tell your user
    // why. You can find the invalid params and reasons in err.params
    console.log('Failed validation', err.params)
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

deactivateItem (itemId, options)

Deactivate an item

API docs: https://developers.recurly.com/api/v2021-02-25#operation/deactivate_item

Returns

Examples

try {
  const item = await client.deactivateItem(itemId)
  console.log('Deleted item: ', item.code)
} catch (err) {
  if (err && err.type === 'not-found') {
    // If the request was not found, you may want to alert the user or
    // just return null
    console.log('Resource Not Found')
  }
  // If we don't know what to do with the err, we should
  // probably re-raise and let our web framework and logger handle it
  throw err
}

reactivateItem (itemId, options)

Reactivate an inactive item

API docs: https://developers.recurly.com/api/v2021-02-25#operation/reactivate_item

Returns

Examples

try {
  const item = await client.reactivateItem(itemId)
  console.log('Reactivated item: ', item.code)
} catch (err) {
  if (err && err.type === 'not_found') {
    // If the request was not found, you may want to alert the user or
    // just return null
    console.log('Resource Not Found')
  }
  // If we don't know what to do with the err, we should
  // probably re-raise and let our web framework and logger handle it
  throw err
}

listMeasuredUnit (options)

List a site's measured units

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_measured_unit

Returns

createMeasuredUnit (body, options)

Create a new measured unit

API docs: https://developers.recurly.com/api/v2021-02-25#operation/create_measured_unit

Returns

getMeasuredUnit (measuredUnitId, options)

Fetch a measured unit

API docs: https://developers.recurly.com/api/v2021-02-25#operation/get_measured_unit

Returns

updateMeasuredUnit (measuredUnitId, body, options)

Update a measured unit

API docs: https://developers.recurly.com/api/v2021-02-25#operation/update_measured_unit

Returns

removeMeasuredUnit (measuredUnitId, options)

Remove a measured unit

API docs: https://developers.recurly.com/api/v2021-02-25#operation/remove_measured_unit

Returns

listExternalProducts (options)

List a site's external products

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_external_products

Returns

createExternalProduct (body, options)

Create an external product

API docs: https://developers.recurly.com/api/v2021-02-25#operation/create_external_product

Returns

getExternalProduct (externalProductId, options)

Fetch an external product

API docs: https://developers.recurly.com/api/v2021-02-25#operation/get_external_product

Returns

updateExternalProduct (externalProductId, body, options)

Update an external product

API docs: https://developers.recurly.com/api/v2021-02-25#operation/update_external_product

Returns

deactivateExternalProducts (externalProductId, options)

Deactivate an external product

API docs: https://developers.recurly.com/api/v2021-02-25#operation/deactivate_external_products

Returns

listExternalProductExternalProductReferences (externalProductId, options)

List the external product references for an external product

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_external_product_external_product_references

Returns

createExternalProductExternalProductReference (externalProductId, body, options)

Create an external product reference on an external product

API docs: https://developers.recurly.com/api/v2021-02-25#operation/create_external_product_external_product_reference

Returns

getExternalProductExternalProductReference (externalProductId, externalProductReferenceId, options)

Fetch an external product reference

API docs: https://developers.recurly.com/api/v2021-02-25#operation/get_external_product_external_product_reference

Returns

deactivateExternalProductExternalProductReference (externalProductId, externalProductReferenceId, options)

Deactivate an external product reference

API docs: https://developers.recurly.com/api/v2021-02-25#operation/deactivate_external_product_external_product_reference

Returns

listExternalSubscriptions (options)

List a site's external subscriptions

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_external_subscriptions

Returns

getExternalSubscription (externalSubscriptionId, options)

Fetch an external subscription

API docs: https://developers.recurly.com/api/v2021-02-25#operation/get_external_subscription

Returns

listExternalSubscriptionExternalInvoices (externalSubscriptionId, options)

List the external invoices on an external subscription

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_external_subscription_external_invoices

Returns

listInvoices (options)

List a site's invoices

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_invoices

Returns

Examples

const invoices = client.listInvoices({ params: { limit: 200 } })

for await (const invoice of invoices.each()) {
  console.log(invoice.number)
}

getInvoice (invoiceId, options)

Fetch an invoice

API docs: https://developers.recurly.com/api/v2021-02-25#operation/get_invoice

Returns

Examples

try {
  const invoice = await client.getInvoice(invoiceId)
  console.log('Fetched Invoice: ', invoice.number)
} catch (err) {
  if (err instanceof recurly.errors.NotFoundError) {
    // If the request was not found, you may want to alert the user or
    // just return null
    console.log('Resource Not Found')
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

updateInvoice (invoiceId, body, options)

Update an invoice

API docs: https://developers.recurly.com/api/v2021-02-25#operation/update_invoice

Returns

Examples

try {
  const invoiceUpdate = {
    customerNotes: "New notes",
    termsAndConditions: "New terms and conditions"
  }

  const invoice = await client.updateInvoice(invoiceId, invoiceUpdate)
  console.log('Edited invoice: ', invoice.number)
} catch(err) {

  if (err instanceof recurly.errors.ValidationError) {
    // If the request was not valid, you may want to tell your user
    // why. You can find the invalid params and reasons in err.params
    console.log('Failed validation', err.params)
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

getInvoicePdf (invoiceId, options)

Fetch an invoice as a PDF

API docs: https://developers.recurly.com/api/v2021-02-25#operation/get_invoice_pdf

Returns

Examples

try {
  const invoice = await client.getInvoicePdf(invoiceId)
  console.log('Fetched Invoice: ', invoice)
  const filename = `${downloadDirectory}/nodeinvoice-${invoiceId}.pdf`
  await fs.writeFile(filename, invoice.data, 'binary', (err) => {
    // throws an error, you could also catch it here
    if (err) throw err;

    // success case, the file was saved
    console.log('Saved Invoice PDF to', filename)
  })
} catch (err) {
  if (err instanceof recurly.errors.NotFoundError) {
    // If the request was not found, you may want to alert the user or
    // just return null
    console.log('Resource Not Found')
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

applyCreditBalance (invoiceId, options)

Apply available credit to a pending or past due charge invoice

API docs: https://developers.recurly.com/api/v2021-02-25#operation/apply_credit_balance

Returns

Examples

try {
  const invoice = await client.applyCreditBalance(invoiceId)
  console.log('Applied credit balance to invoice: ', invoice)
} catch (err) {
  if (err instanceof recurly.errors.ValidationError) {
    // If the request was not valid, you may want to tell your user
    // why. You can find the invalid params and reasons in err.params
    console.log('Failed validation', err.params)
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

collectInvoice (invoiceId, options)

Collect a pending or past due, automatic invoice

API docs: https://developers.recurly.com/api/v2021-02-25#operation/collect_invoice

Returns

Examples

try {
  const invoice = await client.collectInvoice(invoiceId)
  console.log('Collected invoice: ', invoice.number)
} catch (err) {
  if (err instanceof recurly.errors.ValidationError) {
    // If the request was not valid, you may want to tell your user
    // why. You can find the invalid params and reasons in err.params
    console.log('Failed validation', err.params)
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

markInvoiceFailed (invoiceId, options)

Mark an open invoice as failed

API docs: https://developers.recurly.com/api/v2021-02-25#operation/mark_invoice_failed

Returns

Examples

try {
  const invoice = await client.markInvoiceFailed(invoiceId)
  console.log('Failed invoice: ', invoice.number)
} catch (err) {
  if (err instanceof recurly.errors.ValidationError) {
    // If the request was not valid, you may want to tell your user
    // why. You can find the invalid params and reasons in err.params
    console.log('Failed validation', err.params)
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

markInvoiceSuccessful (invoiceId, options)

Mark an open invoice as successful

API docs: https://developers.recurly.com/api/v2021-02-25#operation/mark_invoice_successful

Returns

Examples

try {
  const invoice = await client.markInvoiceSuccessful(invoiceId)
  console.log(`Marked invoice #${invoice.number} successful`)
} catch(err) {

  if (err instanceof recurly.errors.ValidationError) {
    // If the request was not valid, you may want to tell your user
    // why. You can find the invalid params and reasons in err.params
    console.log('Failed validation', err.params)
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

reopenInvoice (invoiceId, options)

Reopen a closed, manual invoice

API docs: https://developers.recurly.com/api/v2021-02-25#operation/reopen_invoice

Returns

Examples

try {
  const invoice = await client.reopenInvoice(invoiceId)
  console.log('Reopened invoice: ', invoice.number)
} catch (err) {
  if (err instanceof recurly.errors.NotFoundError) {
    // If the request was not found, you may want to alert the user or
    // just return null
    console.log('Resource Not Found')
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

voidInvoice (invoiceId, options)

Void a credit invoice.

API docs: https://developers.recurly.com/api/v2021-02-25#operation/void_invoice

Returns

Examples

try {
  const invoice = await client.voidInvoice(invoiceId)
  console.log('Voided invoice: ', invoice)
} catch (err) {
  if (err instanceof recurly.errors.ValidationError) {
    // If the request was not valid, you may want to tell your user
    // why. You can find the invalid params and reasons in err.params
    console.log('Failed validation', err.params)
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

recordExternalTransaction (invoiceId, body, options)

Record an external payment for a manual invoices.

API docs: https://developers.recurly.com/api/v2021-02-25#operation/record_external_transaction

Returns

Examples

try {
  const externalTrx = {
    description: "A check collected outside of Recurly",
    amount: 10.0,
    payment_method: 'check'
  }
  const transaction = await client.recordExternalTransaction(invoiceId, externalTrx)
  console.log('External Transaction: ', transaction)
} catch (err) {
  if (err instanceof recurly.errors.NotFoundError) {
    // If the request was not found, you may want to alert the user or
    // just return null
    console.log('Resource Not Found')
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

listInvoiceLineItems (invoiceId, options)

List an invoice's line items

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_invoice_line_items

Returns

Examples

const lineItems = client.listInvoiceLineItems(invoiceId, { params: { limit: 200 } })

for await (const lineItem of lineItems.each()) {
  console.log(lineItem.id)
}

listInvoiceCouponRedemptions (invoiceId, options)

List the coupon redemptions applied to an invoice

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_invoice_coupon_redemptions

Returns

Examples

const redemptions = client.listInvoiceCouponRedemptions(invoiceId, { params: { limit: 200 } })

for await (const redemption of redemptions.each()) {
  console.log(redemption.id)
}

listRelatedInvoices (invoiceId, options)

List an invoice's related credit or charge invoices

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_related_invoices

Returns

Examples

const invoices = client.listRelatedInvoices(invoiceId, { params: { limit: 200 } })

for await (const invoice of invoices.each()) {
  console.log(invoice.number)
}

refundInvoice (invoiceId, body, options)

Refund an invoice

API docs: https://developers.recurly.com/api/v2021-02-25#operation/refund_invoice

Returns

Examples

try {
  const invoiceRefund = {
    creditCustomerNotes: "Notes on credits",
    type: "amount", // could also be "line_items"
    amount: 100
  }

  const invoice = await client.refundInvoice(invoiceId, invoiceRefund)
  console.log('Refunded invoice: ', invoice.number)
} catch(err) {

  if (err instanceof recurly.errors.ValidationError) {
    // If the request was not valid, you may want to tell your user
    // why. You can find the invalid params and reasons in err.params
    console.log('Failed validation', err.params)
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

listLineItems (options)

List a site's line items

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_line_items

Returns

Examples

const lineItems = client.listLineItems({ params: { limit: 200 } })

for await (const item of lineItems.each()) {
  console.log(`Item ${item.id} for ${item.amount}`)
}

getLineItem (lineItemId, options)

Fetch a line item

API docs: https://developers.recurly.com/api/v2021-02-25#operation/get_line_item

Returns

Examples

try {
  const lineItem = await client.getLineItem(lineItemId)
  console.log('Fetched line item: ', lineItem.uuid)
} catch (err) {
  if (err instanceof recurly.errors.NotFoundError) {
    // If the request was not found, you may want to alert the user or
    // just return null
    console.log('Resource Not Found')
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

removeLineItem (lineItemId, options)

Delete an uninvoiced line item

API docs: https://developers.recurly.com/api/v2021-02-25#operation/remove_line_item

Returns

Examples

try {
  await client.removeLineItem(lineItemId)
  console.log('Removed line item: ', lineItemId)
} catch (err) {
  if (err instanceof recurly.errors.NotFoundError) {
    // If the request was not found, you may want to alert the user or
    // just return null
    console.log('Resource Not Found')
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

listPlans (options)

List a site's plans

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_plans

Returns

Examples

const plans = client.listPlans({ params: { limit: 200 } })

for await (const plan of plans.each()) {
  console.log(plan.code)
}

createPlan (body, options)

Create a plan

API docs: https://developers.recurly.com/api/v2021-02-25#operation/create_plan

Returns

Examples

try {
  const planCreate = {
    name: 'Monthly Coffee Subscription',
    code: planCode,
    currencies: [
      {
        currency: 'USD',
        unitAmount: 10000
      }
    ]
  }
  const plan = await client.createPlan(planCreate)
  console.log('Created Plan: ', plan.code)
} catch (err) {
  if (err instanceof recurly.errors.ValidationError) {
    // If the request was not valid, you may want to tell your user
    // why. You can find the invalid params and reasons in err.params
    console.log('Failed validation', err.params)
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

getPlan (planId, options)

Fetch a plan

API docs: https://developers.recurly.com/api/v2021-02-25#operation/get_plan

Returns

Examples

try {
  const plan = await client.getPlan(planId)
  console.log('Fetched plan: ', plan.code)
} catch (err) {
  if (err instanceof recurly.errors.NotFoundError) {
    // If the request was not found, you may want to alert the user or
    // just return null
    console.log('Resource Not Found')
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

updatePlan (planId, body, options)

Update a plan

API docs: https://developers.recurly.com/api/v2021-02-25#operation/update_plan

Returns

Examples

try {
  const planUpdate = {
    name: 'New monthly coffee subscription'
  }
  const plan = await client.updatePlan(planId, planUpdate)
  console.log('Updated plan: ', plan.code)
} catch (err) {
  if (err instanceof recurly.errors.ValidationError) {
    // If the request was not valid, you may want to tell your user
    // why. You can find the invalid params and reasons in err.params
    console.log('Failed validation', err.params)
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

removePlan (planId, options)

Remove a plan

API docs: https://developers.recurly.com/api/v2021-02-25#operation/remove_plan

Returns

Examples

try {
  const plan = await client.removePlan(planId)
  console.log('Removed plan: ', plan.code)
} catch (err) {
  if (err instanceof recurly.errors.NotFoundError) {
    // If the request was not found, you may want to alert the user or
    // just return null
    console.log('Resource Not Found')
  } else {
    // If we don't know what to do with the err, we should
    // probably re-raise and let our web framework and logger handle it
    console.log('Unknown Error: ', err)
  }
}

listPlanAddOns (planId, options)

List a plan's add-ons

API docs: https://developers.recurly.com/api/v2021-02-25#operation/list_plan_add_ons

Returns

Examples

const addOns = client.listPlanAddOns(planId, { params: { limit: 200 } })

for await (const addOn of addOns.each()) {
  console.log(addOn.code)
}

createPlanAddOn (planId, body, options)

Create an add-on

API docs: https://developers.recurly.com/api/v2021-02-25#operation/create_plan_add_on