SUBSCRIPTIONS_API.md

Subscriptions API

• Subscriptions API
  • Get All Subscriptions
  • Get a Specific Subscription

Get All Subscriptions

Retrieves the subscriptions.

const RenderforestClient = require('@renderforest/sdk-node')

const Renderforest = new RenderforestClient({ signKey: '<signKey>', clientId: -1 })

Renderforest.getSubscriptions({
  status: 'active'
})
  .then(console.log) // handle the success
  .catch(console.error) // handle the error

• The possible values of subscription status are: 'active', 'closed'.

See example

Get a Specific Subscription

Gets a specific subscription.

const RenderforestClient = require('@renderforest/sdk-node')

const Renderforest = new RenderforestClient({ signKey: '<signKey>', clientId: -1 })

Renderforest.getSubscription(122)
  .then(console.log) // handle the success
  .catch(console.error) // handle the error

See example

⬆ back to the top