ShopifySubscriptionProduct (postfinancecheckout-java-sdk 4.0.2 API)

java.lang.Object
- ch.postfinance.sdk.model.ShopifySubscriptionProduct

public class ShopifySubscriptionProduct
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`protected BigDecimal`	`absolutePriceAdjustment`
`protected Integer`	`billingDayOfMonth`
`protected Integer`	`billingIntervalAmount`
`protected ShopifySubscriptionBillingIntervalUnit`	`billingIntervalUnit`
`protected ShopifySubscriptionWeekday`	`billingWeekday`
`protected BigDecimal`	`fixedPrice`
`protected Long`	`id`
`protected Long`	`linkedSpaceId`
`protected Integer`	`maximalBillingCycles`
`protected Integer`	`maximalSuspendableCycles`
`protected Integer`	`minimalBillingCycles`
`protected OffsetDateTime`	`plannedPurgeDate`
`protected ShopifySubscriptionProductPricingOption`	`pricingOption`
`protected String`	`productId`
`protected String`	`productName`
`protected BigDecimal`	`productPrice`
`protected String`	`productSku`
`protected String`	`productVariantId`
`protected String`	`productVariantName`
`protected BigDecimal`	`relativePriceAdjustment`
`protected Boolean`	`shippingRequired`
`protected Long`	`shop`
`protected ShopifySubscriptionProductState`	`state`
`protected Boolean`	`stockCheckRequired`
`protected Boolean`	`storeOrderConfirmationEmailEnabled`
`protected Boolean`	`subscriberSuspensionAllowed`
`protected Integer`	`terminationBillingCycles`
`protected OffsetDateTime`	`updatedAt`
`protected Integer`	`version`

Constructor Summary

Constructors
Constructor and Description

ShopifySubscriptionProduct()

Constructors
Constructor and Description
`ShopifySubscriptionProduct()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`BigDecimal`	`getAbsolutePriceAdjustment()`
`Integer`	`getBillingDayOfMonth()` Define the day of the month on which the recurring orders should be created.
`Integer`	`getBillingIntervalAmount()`
`ShopifySubscriptionBillingIntervalUnit`	`getBillingIntervalUnit()` Define how frequently recurring orders should be created.
`ShopifySubscriptionWeekday`	`getBillingWeekday()` Define the weekday on which the recurring orders should be created.
`BigDecimal`	`getFixedPrice()`
`Long`	`getId()` The ID is the primary key of the entity.
`Long`	`getLinkedSpaceId()` The linked space id holds the ID of the space to which the entity belongs to.
`Integer`	`getMaximalBillingCycles()` Define the maximum number of orders the subscription will run for.
`Integer`	`getMaximalSuspendableCycles()` Define the maximum number of orders the subscription can be suspended for at a time.
`Integer`	`getMinimalBillingCycles()` Define the minimal number of orders the subscription will run for.
`OffsetDateTime`	`getPlannedPurgeDate()` The planned purge date indicates when the entity is permanently removed.
`ShopifySubscriptionProductPricingOption`	`getPricingOption()`
`String`	`getProductId()` The ID of the Shopify product that is enabled to be ordered as subscription.
`String`	`getProductName()`
`BigDecimal`	`getProductPrice()`
`String`	`getProductSku()`
`String`	`getProductVariantId()`
`String`	`getProductVariantName()`
`BigDecimal`	`getRelativePriceAdjustment()`
`Long`	`getShop()`
`ShopifySubscriptionProductState`	`getState()`
`Integer`	`getTerminationBillingCycles()` Define the number of orders the subscription will keep running for after its termination has been requested.
`OffsetDateTime`	`getUpdatedAt()`
`Integer`	`getVersion()` The version number indicates the version of the entity.
`int`	`hashCode()`
`Boolean`	`isShippingRequired()`
`Boolean`	`isStockCheckRequired()`
`Boolean`	`isStoreOrderConfirmationEmailEnabled()` Define whether the order confirmation email of the Shopify shop is sent to the customer for recurring orders.
`Boolean`	`isSubscriberSuspensionAllowed()` Define whether the customer is allowed to suspend subscriptions.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - absolutePriceAdjustment
```
protected BigDecimal absolutePriceAdjustment
```
  - billingDayOfMonth
```
protected Integer billingDayOfMonth
```
  - billingIntervalAmount
```
protected Integer billingIntervalAmount
```
  - billingIntervalUnit
```
protected ShopifySubscriptionBillingIntervalUnit billingIntervalUnit
```
  - billingWeekday
```
protected ShopifySubscriptionWeekday billingWeekday
```
  - fixedPrice
```
protected BigDecimal fixedPrice
```
  - id
```
protected Long id
```
  - linkedSpaceId
```
protected Long linkedSpaceId
```
  - maximalBillingCycles
```
protected Integer maximalBillingCycles
```
  - maximalSuspendableCycles
```
protected Integer maximalSuspendableCycles
```
  - minimalBillingCycles
```
protected Integer minimalBillingCycles
```
  - plannedPurgeDate
```
protected OffsetDateTime plannedPurgeDate
```
  - pricingOption
```
protected ShopifySubscriptionProductPricingOption pricingOption
```
  - productId
```
protected String productId
```
  - productName
```
protected String productName
```
  - productPrice
```
protected BigDecimal productPrice
```
  - productSku
```
protected String productSku
```
  - productVariantId
```
protected String productVariantId
```
  - productVariantName
```
protected String productVariantName
```
  - relativePriceAdjustment
```
protected BigDecimal relativePriceAdjustment
```
  - shippingRequired
```
protected Boolean shippingRequired
```
  - shop
```
protected Long shop
```
  - state
```
protected ShopifySubscriptionProductState state
```
  - stockCheckRequired
```
protected Boolean stockCheckRequired
```
  - storeOrderConfirmationEmailEnabled
```
protected Boolean storeOrderConfirmationEmailEnabled
```
  - subscriberSuspensionAllowed
```
protected Boolean subscriberSuspensionAllowed
```
  - terminationBillingCycles
```
protected Integer terminationBillingCycles
```
  - updatedAt
```
protected OffsetDateTime updatedAt
```
  - version
```
protected Integer version
```
- Constructor Detail
  - ShopifySubscriptionProduct
```
public ShopifySubscriptionProduct()
```
- Method Detail
  - getAbsolutePriceAdjustment
```
public BigDecimal getAbsolutePriceAdjustment()
```
    Returns:
    
    absolutePriceAdjustment
  - getBillingDayOfMonth
```
public Integer getBillingDayOfMonth()
```
    Define the day of the month on which the recurring orders should be created.
    
    Returns:
    
    billingDayOfMonth
  - getBillingIntervalAmount
```
public Integer getBillingIntervalAmount()
```
    Returns:
    
    billingIntervalAmount
  - getBillingIntervalUnit
```
public ShopifySubscriptionBillingIntervalUnit getBillingIntervalUnit()
```
    Define how frequently recurring orders should be created.
    
    Returns:
    
    billingIntervalUnit
  - getBillingWeekday
```
public ShopifySubscriptionWeekday getBillingWeekday()
```
    Define the weekday on which the recurring orders should be created.
    
    Returns:
    
    billingWeekday
  - getFixedPrice
```
public BigDecimal getFixedPrice()
```
    Returns:
    
    fixedPrice
  - getId
```
public Long getId()
```
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
    
    Returns:
    
    id
  - getLinkedSpaceId
```
public Long getLinkedSpaceId()
```
    The linked space id holds the ID of the space to which the entity belongs to.
    
    Returns:
    
    linkedSpaceId
  - getMaximalBillingCycles
```
public Integer getMaximalBillingCycles()
```
    Define the maximum number of orders the subscription will run for.
    
    Returns:
    
    maximalBillingCycles
  - getMaximalSuspendableCycles
```
public Integer getMaximalSuspendableCycles()
```
    Define the maximum number of orders the subscription can be suspended for at a time.
    
    Returns:
    
    maximalSuspendableCycles
  - getMinimalBillingCycles
```
public Integer getMinimalBillingCycles()
```
    Define the minimal number of orders the subscription will run for.
    
    Returns:
    
    minimalBillingCycles
  - getPlannedPurgeDate
```
public OffsetDateTime getPlannedPurgeDate()
```
    The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.
    
    Returns:
    
    plannedPurgeDate
  - getPricingOption
```
public ShopifySubscriptionProductPricingOption getPricingOption()
```
    Returns:
    
    pricingOption
  - getProductId
```
public String getProductId()
```
    The ID of the Shopify product that is enabled to be ordered as subscription.
    
    Returns:
    
    productId
  - getProductName
```
public String getProductName()
```
    Returns:
    
    productName
  - getProductPrice
```
public BigDecimal getProductPrice()
```
    Returns:
    
    productPrice
  - getProductSku
```
public String getProductSku()
```
    Returns:
    
    productSku
  - getProductVariantId
```
public String getProductVariantId()
```
    Returns:
    
    productVariantId
  - getProductVariantName
```
public String getProductVariantName()
```
    Returns:
    
    productVariantName
  - getRelativePriceAdjustment
```
public BigDecimal getRelativePriceAdjustment()
```
    Returns:
    
    relativePriceAdjustment
  - isShippingRequired
```
public Boolean isShippingRequired()
```
    Returns:
    
    shippingRequired
  - getShop
```
public Long getShop()
```
    Returns:
    
    shop
  - getState
```
public ShopifySubscriptionProductState getState()
```
    Returns:
    
    state
  - isStockCheckRequired
```
public Boolean isStockCheckRequired()
```
    Returns:
    
    stockCheckRequired
  - isStoreOrderConfirmationEmailEnabled
```
public Boolean isStoreOrderConfirmationEmailEnabled()
```
    Define whether the order confirmation email of the Shopify shop is sent to the customer for recurring orders.
    
    Returns:
    
    storeOrderConfirmationEmailEnabled
  - isSubscriberSuspensionAllowed
```
public Boolean isSubscriberSuspensionAllowed()
```
    Define whether the customer is allowed to suspend subscriptions.
    
    Returns:
    
    subscriberSuspensionAllowed
  - getTerminationBillingCycles
```
public Integer getTerminationBillingCycles()
```
    Define the number of orders the subscription will keep running for after its termination has been requested.
    
    Returns:
    
    terminationBillingCycles
  - getUpdatedAt
```
public OffsetDateTime getUpdatedAt()
```
    Returns:
    
    updatedAt
  - getVersion
```
public Integer getVersion()
```
    The version number indicates the version of the entity. The version is incremented whenever the entity is changed.
    
    Returns:
    
    version
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ShopifySubscriptionProduct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

absolutePriceAdjustment

billingDayOfMonth

billingIntervalAmount

billingIntervalUnit

billingWeekday

fixedPrice

id

linkedSpaceId

maximalBillingCycles

maximalSuspendableCycles

minimalBillingCycles

plannedPurgeDate

pricingOption

productId

productName

productPrice

productSku

productVariantId

productVariantName

relativePriceAdjustment

shippingRequired

shop

state

stockCheckRequired

storeOrderConfirmationEmailEnabled

subscriberSuspensionAllowed

terminationBillingCycles

updatedAt

version

Constructor Detail

ShopifySubscriptionProduct

Method Detail

getAbsolutePriceAdjustment

getBillingDayOfMonth

getBillingIntervalAmount

getBillingIntervalUnit

getBillingWeekday

getFixedPrice

getId

getLinkedSpaceId

getMaximalBillingCycles

getMaximalSuspendableCycles

getMinimalBillingCycles

getPlannedPurgeDate

getPricingOption

getProductId

getProductName

getProductPrice

getProductSku

getProductVariantId

getProductVariantName

getRelativePriceAdjustment

isShippingRequired

getShop

getState

isStockCheckRequired

isStoreOrderConfirmationEmailEnabled

isSubscriberSuspensionAllowed

getTerminationBillingCycles

getUpdatedAt

getVersion

equals

hashCode

toString