Class SubscriptionBase

NetSuite Subscription record type

Hierarchy (view full)

Constructors

constructor

Properties

_id advancerenewalperiodnumber advancerenewalperiodunit autoname autorenewal billingaccount billingaccountstartdate billingschedule billingsubscriptionstatus currency customer customform defaultValues? defaultrenewalmethod defaultrenewalplan defaultrenewalpricebook defaultrenewalterm defaultrenewaltrantype enddate estimatedrevrecenddate externalid frequency idnumber initialterm initialtermduration initialtermtype initialtermunits internalid lastbillcycledate lastbilldate name nextbillcycledate nextrenewalstartdate nsrecord otherrecordnumber pricebook priceinterval renewalnumber salesorder startdate sublinefromplan subscriptionline subscriptionplan subscriptionplanname subscriptionrevision subsidiary templatestored

Accessors

id

Methods

getField save toJSON recordType

Constructors

constructor

  • new SubscriptionBase(id, isDynamic?): SubscriptionBase

  • Loads an existing record with the given internal id

    Parameters

    • id: NonNullable<string | number>

      record internal id to load

    • OptionalisDynamic: boolean

      set true if you want to load the record in dynamic mode

    Returns SubscriptionBase

    Example

    // load customer with internal id 123
    const c = new Customer(123)
  • new SubscriptionBase(rec): SubscriptionBase

  • Creates an NSDAL instance for the given existing NetSuite record object. This does NOT reload the record - it just wraps the supplied rec

    Parameters

    • rec: NonNullable<ClientCurrentRecord | Record>

      an existing netsuite record

    Returns SubscriptionBase

    Example

    // assume `ctx` is the _context_ object passed to a `beforeSubmit()` entrypoint.
    // results in an NFT representation of the 'new record'
    const customer = new Customer(ctx.newRecord)
  • new SubscriptionBase(unused?, isDynamic?, defaultvalues?): SubscriptionBase

  • creates a new record

    Parameters

    • Optionalunused: Nullable<string | number>

      either null or leave this parameter out entirely

    • OptionalisDynamic: boolean

      true if you want to create the record in dynamic mode, otherwise uses standard mode.

    • Optionaldefaultvalues: object

      optional defaultvalues object - specific to certain records that allow initializing a new record.

    Returns SubscriptionBase

    Example

    // start a new customer record
    const c = new Customer()

    // start a new customer record in dynamic mode
    const c = new Customer(null, true)

Properties

Protected_id

_id: number

Netsuite internal id of this record

advancerenewalperiodnumber

advancerenewalperiodnumber: number

advancerenewalperiodunit

advancerenewalperiodunit: string | number

NetSuite lists this as a select field, but often the value is a string (e.g. DAYS).

autoname

autoname: boolean

Auto

autorenewal

autorenewal: boolean

Automatically Initiate Renewal Process

billingaccount

billingaccount: number

Billing Account

billingaccountstartdate

billingaccountstartdate: Date

Billing Account Start Date | As of 1/20/22, NetSuite says this is a required field, which is incorrect. It is most likely being confused with startdate.

billingschedule

billingschedule: number

Billing Schedule

billingsubscriptionstatus

billingsubscriptionstatus: string | number

Status | NetSuite lists this as a select field, but it is a string value (e.g. ACTIVE).

currency

currency: number

Currency

customer

customer: number

Customer

customform

customform: number

Custom Form

Protected OptionaldefaultValues

defaultValues?: object

defaultrenewalmethod

defaultrenewalmethod: string | number

Default Renewal Method | NetSuite lists this as a select field, but it is a string value (e.g. CREATE_NEW_SUBSCRIPTION). This is optional when Initial Term is Evergreen.

defaultrenewalplan

defaultrenewalplan: number

Default Renewal Plan | This is optional when Initial Term is Evergreen.

defaultrenewalpricebook

defaultrenewalpricebook: number

Default Renewal Price Book

defaultrenewalterm

defaultrenewalterm: number

Default Renewal Term | This is optional when Initial Term is Evergreen.

defaultrenewaltrantype

defaultrenewaltrantype: number

Default Renewal Transaction Type

enddate

enddate: Date

End Date

estimatedrevrecenddate

estimatedrevrecenddate: Date

Estimated Revenue Recognition End Date

externalid

externalid: string

External ID

frequency

frequency: string | number

Billing Frequency | NetSuite lists this as a select field, but it is a string value (e.g. MONTHLY).

idnumber

idnumber: null | string

Subscription ID

initialterm

initialterm: number

Initial Term

initialtermduration

initialtermduration: number

Initial Term Duration

initialtermtype

initialtermtype: number

Initial Term Type | NetSuite lists this as a select field, but it is a string value (e.g. EVERGREEN).

initialtermunits

initialtermunits: string | number

Initial Term Units | NetSuite lists this as a select field, but it is a string value (e.g. MONTHS).

internalid

internalid: number

Internal ID

lastbillcycledate

lastbillcycledate: Date

Last Bill Cycle Date

lastbilldate

lastbilldate: Date

Last Bill Date

name

name: string

Subscription Name

nextbillcycledate

nextbillcycledate: Date

Next Bill Cycle Date

nextrenewalstartdate

nextrenewalstartdate: Date

Next Renewal Start Date

nsrecord

nsrecord: Record

underlying netsuite record

otherrecordnumber

otherrecordnumber: string

Other Record Number

pricebook

pricebook: number

Price Book

priceinterval

priceinterval: Sublist<PriceBookLinesSublist>

priceinterval - Price Book Lines (Sublist)

renewalnumber

renewalnumber: number

Number of Renewal

salesorder

salesorder: number

Originating Sales Order

startdate

startdate: Date

Start Date | As of 1/20/22, NetSuite says this is not a required field, which is incorrect. It is most likely being confused with billingaccountstartdate.

sublinefromplan

sublinefromplan: Sublist<SublineFromPlanSublist>

sublinefromplan - Lines (Sublist)

subscriptionline

subscriptionline: Sublist<SubscriptionLineSublist>

subscriptionline - Lines (Sublist)

subscriptionplan

subscriptionplan: number

Subscription Plan

subscriptionplanname

subscriptionplanname: string

Subscription Plan Name

subscriptionrevision

subscriptionrevision: number

Subscription Revision

subsidiary

subsidiary: number

Subsidiary

templatestored

templatestored: boolean

Template Stored

Accessors

id

  • get id(): number

  • Returns number

Methods

getField

  • getField(field): Field

  • Returns NetSuite field metadata. Useful for doing things like disabling a field on the form programmatically.

    Parameters

    Returns Field

save

  • save(enableSourcing?, ignoreMandatoryFields?): number

  • Persists this record to the NS database

    Parameters

    • OptionalenableSourcing: boolean
    • OptionalignoreMandatoryFields: boolean

    Returns number

toJSON

StaticrecordType

  • recordType(): Type

  • The netsuite record type (constant string) - this is declared here and overridden in derived classes

    Returns Type

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods